Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-09 06:18:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Miscellaneous JSDoc fixes noticed in passing

Browse source
This commit is contained in:
David Rowe 2018-05-01 21:55:45 +12:00
parent 65f5915372
commit 2482da3c25
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
libraries/controllers/src/controllers/impl/MappingBuilderProxy.h
View file

@ -39,7 +39,9 @@ class UserInputMapper;
* methods.</li> * methods.</li>
* <li>Use {@link Controller.parseMapping} or {@link Controller.loadMapping} to load a {@link Controller.MappingJSON}.</li> * <li>Use {@link Controller.parseMapping} or {@link Controller.loadMapping} to load a {@link Controller.MappingJSON}.</li>
* </ul> * </ul>
* <p>Enable the mapping using {@link MappingObject#enable|enable} or {@link Controller.enableMapping} for it to take effect. *
* <p>Enable the mapping using {@link MappingObject#enable|enable} or {@link Controller.enableMapping} for it to take
* effect.</p>
* *
* <p>Mappings and their routes are applied according to the following rules:</p> * <p>Mappings and their routes are applied according to the following rules:</p>
* <ul> * <ul>
@ -49,7 +51,7 @@ class UserInputMapper;
* output that already has a route the new route is ignored.</li> * output that already has a route the new route is ignored.</li>
* <li>New mappings override previous mappings: each output is processed using the route in the most recently enabled * <li>New mappings override previous mappings: each output is processed using the route in the most recently enabled
* mapping that contains that output.</li> * mapping that contains that output.</li>
* </p> * </ul>
* *
* @class MappingObject * @class MappingObject
*/ */

3
libraries/controllers/src/controllers/impl/RouteBuilderProxy.h
View file

@ -29,7 +29,8 @@ class ScriptingInterface;
* <p>A route in a {@link MappingObject} used by the {@link Controller} API.</p> * <p>A route in a {@link MappingObject} used by the {@link Controller} API.</p>
* *
* <p>Create a route using {@link MappingObject} methods and apply this object's methods to process it, terminating with * <p>Create a route using {@link MappingObject} methods and apply this object's methods to process it, terminating with
* {@link RouteObject#to} to apply it to a <code>Standard</code> control, action, or script function.</p> * {@link RouteObject#to} to apply it to a <code>Standard</code> control, action, or script function. Note: Loops are not
* permitted.</p>
* *
* <p>Some methods apply to routes with number data, some apply routes with {@link Pose} data, and some apply to both route * <p>Some methods apply to routes with number data, some apply routes with {@link Pose} data, and some apply to both route
* types.<p> * types.<p>