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

Entities properties JSDoc fixes

Browse source
This commit is contained in:
David Rowe 2018-02-23 19:27:40 +13:00
parent 26404a6ce8
commit 895c354257
2 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
libraries/entities/src/EntityItemProperties.cpp
View file

@ -809,7 +809,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
/**jsdoc
* The <code>"PolyVox"</code> {@link Entities.EntityType|EntityType} displays a set of textured voxels.
* It has properties in addition to the common {@link Entities.EntityProperties|EntityProperties}.<br />
* It has properties in addition to the common {@link Entities.EntityProperties|EntityProperties}.
* If you have two or more neighboring PolyVox entities of the same size abutting each other, you can display them as joined by
* configuring their <code>voxelSurfaceStyle</code> and neighbor ID properties.<br />
* PolyVox entities uses a library from <a href="http://www.volumesoffun.com/">Volumes of Fun</a>. Their

24
libraries/entities/src/EntityTypes.h
View file

@ -42,33 +42,33 @@ public:
* <tr><th>Value</th><th>Description</th><th>Properties</th></tr>
* </thead>
* <tbody>
* <tr><td><code>Box</code></td><td>A rectangular prism. This is identical to the <code>Shape</code> EntityType except
* <tr><td><code>"Box"</code></td><td>A rectangular prism. This is identical to the <code>Shape</code> EntityType except
* that it is always created with an initial <code>shape</code> property value of <code>"Cube"</code>.</td>
* <td>{@link Entities.EntityProperties-Box|EntityProperties-Box}</td></tr>
* <tr><td><code>Light</code></td><td>A local lighting effect.</td>
* <tr><td><code>"Light"</code></td><td>A local lighting effect.</td>
* <td>{@link Entities.EntityProperties-Light|EntityProperties-Light}</td></tr>
* <tr><td><code>Line</code></td><td>A sequence of one or more simple straight lines.</td>
* <tr><td><code>"Line"</code></td><td>A sequence of one or more simple straight lines.</td>
* <td>{@link Entities.EntityProperties-Line|EntityProperties-Line}</td></tr>
* <tr><td><code>Model</code></td><td>A mesh model from an FBX or OBJ file.</td>
* <tr><td><code>"Model"</code></td><td>A mesh model from an FBX or OBJ file.</td>
* <td>{@link Entities.EntityProperties-Model|EntityProperties-Model}</td></tr>
* <tr><td><code>ParticleEffect</code></td><td>A particle system that can be used to simulate things such as fire,
* <tr><td><code>"ParticleEffect"</code></td><td>A particle system that can be used to simulate things such as fire,
* smoke, snow, magic spells, etc.</td>
* <td>{@link Entities.EntityProperties-ParticleEffect|EntityProperties-ParticleEffect}</td></tr>
* <tr><td><code>PolyLine</code></td><td>A sequence of one or more textured straight lines.</td>
* <tr><td><code>"PolyLine"</code></td><td>A sequence of one or more textured straight lines.</td>
* <td>{@link Entities.EntityProperties-PolyLine|EntityProperties-PolyLine}</td></tr>
* <tr><td><code>PolyVox</code></td><td>A set of textured voxels.</td>
* <tr><td><code>"PolyVox"</code></td><td>A set of textured voxels.</td>
* <td>{@link Entities.EntityProperties-PolyVox|EntityProperties-PolyVox}</td></tr>
* <tr><td><code>Shape</code></td><td>A basic entity such as a cube.
* <tr><td><code>"Shape"</code></td><td>A basic entity such as a cube.
* See also, the <code>Box</code> and <code>Sphere</code> entity types.</td>
* <td>{@link Entities.EntityProperties-Shape|EntityProperties-Shape}</td></tr>
* <tr><td><code>Sphere</code></td><td>A sphere. This is identical to the <code>Shape</code> EntityType except that it is
* <tr><td><code>"Sphere"</code></td><td>A sphere. This is identical to the <code>Shape</code> EntityType except that it is
* always created with an initial <code>shape</code> property value of <code>"Sphere"</code>.</td>
* <td>{@link Entities.EntityProperties-Sphere|EntityProperties-Sphere}</td></tr>
* <tr><td><code>Text</code></td><td>A pane of text oriented in space.</td>
* <tr><td><code>"Text"</code></td><td>A pane of text oriented in space.</td>
* <td>{@link Entities.EntityProperties-Text|EntityProperties-Text}</td></tr>
* <tr><td><code>Web</code></td><td>A browsable Web page.</td>
* <tr><td><code>"Web"</code></td><td>A browsable Web page.</td>
* <td>{@link Entities.EntityProperties-Web|EntityProperties-Web}</td></tr>
* <tr><td><code>Zone</code></td><td>A volume of lighting effects and avatar permissions.</td>
* <tr><td><code>"Zone"</code></td><td>A volume of lighting effects and avatar permissions.</td>
* <td>{@link Entities.EntityProperties-Zone|EntityProperties-Zone}</td></tr>
* </tbody>
* </table>