History

jsdocs: Do not list scaleWithAvatar as separate property, and document 0 as default for parentJointIndex

sabrina-shanman committed 8 years ago

Commit f0de3ef1 parent 728f8ae2 files · +7 −10Browse files

Showing the changes to interface/src/raypick/PointerScriptingInterface.cpp (1 of 2 files). Show all

Unified · Split

interface/src/raypick/PointerScriptingInterface.cpp+2−4
@@ -97,8 +97,7 @@ unsigned int PointerScriptingInterface::createStylus(const QVariant& properties) · 96 unmodified lines
97 * @property {boolean} [centerEndY=true] If false, the end of the Pointer will be moved up by half of its height.97 * @property {boolean} [centerEndY=true] If false, the end of the Pointer will be moved up by half of its height.
98 * @property {boolean} [lockEnd=false] If true, the end of the Pointer will lock on to the center of the object at which the pointer is pointing.98 * @property {boolean} [lockEnd=false] If true, the end of the Pointer will lock on to the center of the object at which the pointer is pointing.
99 * @property {boolean} [distanceScaleEnd=false] If true, the dimensions of the end of the Pointer will scale linearly with distance.99 * @property {boolean} [distanceScaleEnd=false] If true, the dimensions of the end of the Pointer will scale linearly with distance.
100 * @property {boolean} [scaleWithParent=false] If true, the width of the Pointer's path will scale linearly with the pick parent's scale.100 * @property {boolean} [scaleWithParent=false] If true, the width of the Pointer's path will scale linearly with the pick parent's scale. scaleWithAvatar is an alias but is deprecated.
101 * @property {boolean} [scaleWithAvatar] Alias for scaleWithParent
102 * @property {boolean} [followNormal=false] If true, the end of the Pointer will rotate to follow the normal of the intersected surface.101 * @property {boolean} [followNormal=false] If true, the end of the Pointer will rotate to follow the normal of the intersected surface.
103 * @property {number} [followNormalStrength=0.0] The strength of the interpolation between the real normal and the visual normal if followNormal is true. <code>0-1</code>. If 0 or 1,102 * @property {number} [followNormalStrength=0.0] The strength of the interpolation between the real normal and the visual normal if followNormal is true. <code>0-1</code>. If 0 or 1,
104 * the normal will follow exactly.103 * the normal will follow exactly.
@@ -251,8 +250,7 @@ unsigned int PointerScriptingInterface::createLaserPointer(const QVariant& prope · 146 unmodified lines
251* @property {boolean} [centerEndY=true] If false, the end of the Pointer will be moved up by half of its height.250* @property {boolean} [centerEndY=true] If false, the end of the Pointer will be moved up by half of its height.
252* @property {boolean} [lockEnd=false] If true, the end of the Pointer will lock on to the center of the object at which the pointer is pointing.251* @property {boolean} [lockEnd=false] If true, the end of the Pointer will lock on to the center of the object at which the pointer is pointing.
253* @property {boolean} [distanceScaleEnd=false] If true, the dimensions of the end of the Pointer will scale linearly with distance.252* @property {boolean} [distanceScaleEnd=false] If true, the dimensions of the end of the Pointer will scale linearly with distance.
254* @property {boolean} [scaleWithParent=true] If true, the width of the Pointer's path will scale linearly with the pick parent's scale.253* @property {boolean} [scaleWithParent=true] If true, the width of the Pointer's path will scale linearly with the pick parent's scale. scaleWithAvatar is an alias but is deprecated.
255* @property {boolean} [scaleWithAvatar] Alias for scaleWithParent
256* @property {boolean} [followNormal=false] If true, the end of the Pointer will rotate to follow the normal of the intersected surface.254* @property {boolean} [followNormal=false] If true, the end of the Pointer will rotate to follow the normal of the intersected surface.
257* @property {number} [followNormalStrength=0.0] The strength of the interpolation between the real normal and the visual normal if followNormal is true. <code>0-1</code>. If 0 or 1,255* @property {number} [followNormalStrength=0.0] The strength of the interpolation between the real normal and the visual normal if followNormal is true. <code>0-1</code>. If 0 or 1,
258* the normal will follow exactly.256* the normal will follow exactly.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t