Changeset 978 for cpp/frams

Timestamp:

07/08/20 01:51:27 (4 years ago)

Author:

Maciej Komosinski

Message:

Mentioned newly added enum in the documentation of NeuroClass::getPreferredLocation()

File:

• cpp/frams/model/modelparts.h (modified) (1 diff)

cpp/frams/model/modelparts.h

@@ -278 +278 @@
         int getPreferredOutput() { return (int)prefoutput; }
 
-        /** @return 0 if the object doesn't need any assignment to the body element.
-                @return 1 = it likes to be attached to the Part ( @see Neuro::attachToPart() )
-                @return 2 = the object prefers to have the Joint ( @see Neuro::attachToJoint() )
+        /** @return 0 (PREFER_UNATTACHED) if the neuron doesn't need any assignment to a body element.
+                @return 1 (PREFER_PART) if the neuron likes to be attached to a Part ( @see Neuro::attachToPart() )
+                @return 2 (PREFER_JOINT) if the neuron prefers to be attached to a Joint ( @see Neuro::attachToJoint() )
                 */
         int getPreferredLocation() { return (int)preflocation; }