From 9a353232950b328678ac457bd5afddfb81ade4de Mon Sep 17 00:00:00 2001 From: Kalila L Date: Fri, 18 Sep 2020 16:27:42 -0400 Subject: [PATCH] Update entities API docs to show entity properties at top. --- libraries/entities/src/EntityScriptingInterface.h | 5 ++++- tools/jsdoc/plugins/hifiJSONExport.js | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/libraries/entities/src/EntityScriptingInterface.h b/libraries/entities/src/EntityScriptingInterface.h index dae0922f4a..1375f53030 100644 --- a/libraries/entities/src/EntityScriptingInterface.h +++ b/libraries/entities/src/EntityScriptingInterface.h @@ -4,6 +4,7 @@ // // Created by Brad Hefta-Gaub on 12/6/13. // Copyright 2013 High Fidelity, Inc. +// Copyright 2020 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html @@ -110,9 +111,11 @@ public: * displayed and so knows about. For assignment client scripts, the entities available are those that are "seen" by the * {@link EntityViewer}. For entity server scripts, all entities are available.

* - *

Entity Types

+ *

Entity Types & Properties

* *

For a list of the entity types that you can use, see {@link Entities.EntityType|Entity Types}.

+ * + *

While each entity type has properties that are specific to it, there are properties that are universal to all entity types, see {@link Entities.EntityProperties|Entity Properties}.

* *

Entity Methods

* diff --git a/tools/jsdoc/plugins/hifiJSONExport.js b/tools/jsdoc/plugins/hifiJSONExport.js index cd14c9faad..e609b30ad5 100644 --- a/tools/jsdoc/plugins/hifiJSONExport.js +++ b/tools/jsdoc/plugins/hifiJSONExport.js @@ -13,7 +13,7 @@ exports.handlers = { return console.log(err); } - console.log("The Hifi JSDoc JSON was saved!"); + console.log("The Vircadia JSDoc JSON was saved!"); }); } };