From 91671722a5fea77be4d59cfede583ab06d891805 Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Sat, 25 Nov 2017 16:09:54 +1300
Subject: [PATCH] Add Shape API types JSDoc

---
 libraries/render-utils/src/GeometryCache.cpp | 26 ++++++++++++++++++++
 tools/jsdoc/plugins/hifi.js                  |  1 +
 2 files changed, 27 insertions(+)

diff --git a/libraries/render-utils/src/GeometryCache.cpp b/libraries/render-utils/src/GeometryCache.cpp
index ebf0f13d97..76c354bdf8 100644
--- a/libraries/render-utils/src/GeometryCache.cpp
+++ b/libraries/render-utils/src/GeometryCache.cpp
@@ -74,6 +74,32 @@ static std::array<GeometryCache::Shape, (GeometryCache::NUM_SHAPES - 1)> MAPPING
         GeometryCache::Cylinder,
 } };
 
+/**jsdoc
+* <p>{@link Entities} and {@link Overlays} may have the following geometrical shapes:</p>
+* <table>
+*   <thead>
+*     <tr><th>Value</th><th>Description</th></tr>
+*   </thead>
+*   <tbody>
+*     <tr><td><code>Line</code></td><td>A 1D line oriented in 3 dimensions.</td></tr>
+*     <tr><td><code>Triangle</code></td><td>A triangular prism.</td></tr>
+*     <tr><td><code>Quad</code></td><td>A 2D square oriented in 3 dimensions.</tr>
+*     <tr><td><code>Hexagon</code></td><td>A hexagonal prism.</td></tr>
+*     <tr><td><code>Octagon</code></td><td>An octagonal prism.</td></tr>
+*     <tr><td><code>Circle</code></td><td>A 2D circle oriented in 3 dimensions.</td></td></tr>
+*     <tr><td><code>Cube</code></td><td>A cube.</td></tr>
+*     <tr><td><code>Sphere</code></td><td>A sphere.</td></tr>
+*     <tr><td><code>Tetrahedron</code></td><td>A tetrahedron.</td></tr>
+*     <tr><td><code>Octahedron</code></td><td>An octahedron.</td></tr>
+*     <tr><td><code>Dodecahedron</code></td><td>A dodecahedron.</td></tr>
+*     <tr><td><code>Icosahedron</code></td><td>An icosahedron.</td></tr>
+*     <tr><td><code>Torus</code></td><td>A torus. <em>Not implemented.</em></td></tr>
+*     <tr><td><code>Cone</code></td><td>A cone.</td></tr>
+*     <tr><td><code>Cylinder</code></td><td>A cylinder.</td></tr>
+*   </tbody>
+* </table>
+* @typedef {string} Shape
+*/
 static const std::array<const char * const, GeometryCache::NUM_SHAPES> GEOCACHE_SHAPE_STRINGS{ {
         "Line",
         "Triangle",
diff --git a/tools/jsdoc/plugins/hifi.js b/tools/jsdoc/plugins/hifi.js
index 9818f70f6a..ce691126d8 100644
--- a/tools/jsdoc/plugins/hifi.js
+++ b/tools/jsdoc/plugins/hifi.js
@@ -23,6 +23,7 @@ exports.handlers = {
             '../../libraries/controllers/src/controllers/',
             '../../libraries/entities/src',
             '../../libraries/networking/src',
+            '../../libraries/render-utils/src',
             '../../libraries/shared/src',
             '../../libraries/shared/src/shared',
             '../../libraries/script-engine/src',