* Javadoc clarification in Spatial.setCullHint and setBatchHint (http://hub.jmonkeyengine.org/forum/topic/spatial-setcullhint-documentation/)

git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@10824 75d07b2b-3a1a-0410-a2c5-0572b91ccdca

engine/src/core/com/jme3/scene/Spatial.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2013 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -1343,25 +1343,28 @@ public abstract class Spatial implements Savable, Cloneable, Collidable, Cloneab
     }
 
     /**
-     * <code>setCullHint</code> sets how scene culling should work on this
+     * <code>setCullHint</code> alters how view frustum culling will treat this
-     * spatial during drawing. NOTE: You must set this AFTER attaching to a 
+     * spatial.
-     * parent or it will be reset with the parent's cullMode value.
      *
-     * @param hint
+     * @param hint one of: <code>CullHint.Dynamic</code>,
-     *            one of CullHint.Dynamic, CullHint.Always, CullHint.Inherit or
+     * <code>CullHint.Always</code>, <code>CullHint.Inherit</code>, or
-     *            CullHint.Never
+     * <code>CullHint.Never</code>
+     * <p>
+     * The effect of the default value (CullHint.Inherit) may change if the
+     * spatial gets re-parented.
      */
     public void setCullHint(CullHint hint) {
         cullHint = hint;
     }
 
     /**
-     * <code>setBatchHint</code> sets how batching should work on this
+     * <code>setBatchHint</code> alters how batching will treat this spatial.
-     * spatial. NOTE: You must set this AFTER attaching to a 
-     * parent or it will be reset with the parent's cullMode value.
      *
-     * @param hint
+     * @param hint one of: <code>BatchHint.Never</code>,
-     *            one of BatchHint.Never, BatchHint.Always, BatchHint.Inherit 
+     * <code>BatchHint.Always</code>, or <code>BatchHint.Inherit</code>
+     * <p>
+     * The effect of the default value (BatchHint.Inherit) may change if the
+     * spatial gets re-parented.
      */
     public void setBatchHint(BatchHint hint) {
         batchHint = hint;