Doxygen fixes.

gameplay3d · Jan 24, 2015 · 4ed4ab6 · 4ed4ab6
1 parent 5a1aecc
commit 4ed4ab6
Show file tree

Hide file tree

Showing 14 changed files with 169 additions and 93 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ## GamePlay v3.0.0
 
-GamePlay is an open-source, cross-platform native C++ game framework making it easy to learn and write mobile and desktop games. 
+GamePlay is an open-source, cross-platform native C++ game framework for creating 2D/3D mobile and desktop games.
 
 <img align="right" src="https://raw.github.com/wiki/gameplay3d/GamePlay/img/logo.png" alt="gameplay3d" />
 

diff --git a/api/header.html b/api/header.html
@@ -1,34 +1,34 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<title>gameplay: Main Page</title>
-
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
-<link href="custom.css" rel="stylesheet" type="text/css" />
-
-<link href="search/search.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="jquery.js"></script>
-<script type="text/javascript" src="search/search.js"></script>
-<script type="text/javascript">
-  $(document).ready(function() { searchBox.OnSelectItem(0); });
-</script>
-
-</head>
-<body>
-<div id="top"><!-- do not remove this div! -->
-<table class="header" border="0">
-<tbody>
-<tr>
-<td id="logo"><a href="http://gameplay3d.org/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
-<td width="100%"/>
-<td><a href="http://gameplay3d.org/"><span class="button">overview</span></a></td><td width="12px"/>
-<td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
-<td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
-<td><a href="http://www.gameplay3d.org/forums"><span class="button">forums</span></a></td>
-<td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
-</tr>
-</tbody>
-</table>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<title>gameplay: Main Page</title>
+
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+<link href="custom.css" rel="stylesheet" type="text/css" />
+
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+  $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+
+</head>
+<body>
+<div id="top"><!-- do not remove this div! -->
+<table class="header" border="0">
+<tbody>
+<tr>
+<td id="logo"><a href="http://gameplay3d.org/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
+<td width="100%"/>
+<td><a href="http://gameplay3d.org/"><span class="button">overview</span></a></td><td width="12px"/>
+<td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
+<td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
+<td><a href="http://www.gameplay3d.org/forums"><span class="button">forums</span></a></td>
+<td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
+</tr>
+</tbody>
+</table>
diff --git a/gameplay/src/Control.h b/gameplay/src/Control.h
@@ -1348,10 +1348,10 @@ class Control : public Ref, public AnimationTarget, public ScriptTarget
      *
      * @param s A string in the format of either 'N, N' or 'N%, N%' (where N is a number)
      * @param v1 Set to the value of the first number in the string
-     * @param v1 Set to the value of the second number in the string
+     * @param v2 Set to the value of the second number in the string
      * @param v1Percentage Set to true if the first number should be treated as a percentage
      * @param v2Percentage Set to true if the second number should be treated as a percentage
-     * @return True if the string was parsed
+     * @return true if the string was parsed
      */
     static bool parseCoordPair(const char* s, float* v1, float* v2, bool* v1Percentage, bool* v2Percentage);
 

diff --git a/gameplay/src/Curve.h b/gameplay/src/Curve.h
@@ -339,8 +339,10 @@ class Curve : public Ref
      * Sets the tangents for a point on the curve specified by the index.
      *
      * @param index The index of the point.
-     *
-     *
+     * @param type The interpolation type.
+     * @param type The curve interpolation type.
+     * @param inValue The tangent approaching the point.
+     * @param outValue The tangent leaving the point.
      */
     void setTangent(unsigned int index, InterpolationType type, float* inValue, float* outValue);
 

diff --git a/gameplay/src/Drawable.h b/gameplay/src/Drawable.h
@@ -12,10 +12,10 @@ class NodeCloneContext;
  */
 class Drawable
 {
-public:
-
     friend class Node;
 
+public:
+
     /**
      * Constructor.
      */
@@ -59,6 +59,9 @@ class Drawable
      */
     virtual void setNode(Node* node);
 
+    /**
+     * Node this drawable is attached to.
+     */
     Node* _node;
 };
 

diff --git a/gameplay/src/JoystickControl.h b/gameplay/src/JoystickControl.h
@@ -131,6 +131,7 @@ class JoystickControl : public Control
     /**
      * Sets the radius of joystick motion
      *
+     * @param radius The radius to be set.
      * @param isPercentage If the radius value is a percentage value of the relative size of this control
      */
     void setRadius(float radius, bool isPercentage = false);

diff --git a/gameplay/src/Node.h b/gameplay/src/Node.h
@@ -416,18 +416,19 @@ class Node : public Transform, public Ref
     /**
      * Gets the drawable object attached to this node.
      *
-     *
-     * @return The model attached to this node.
+     * @return The drawable component attached to this node.
      */
     Drawable* getDrawable() const;
 
     /**
-     * Set the drawable object to be attached to this node.
+     * Set the drawable object to be attached to this node
+     *
+     * This is typically a Model, ParticleEmiiter, Form, Terrrain, Sprite, TileSet or Text.
      *
      * This will increase the reference count of the new drawble and decrease
      * the reference count of the old drawable.
      *
-     * @param model The new model. May be NULL.
+     * @param drawable The new drawable component. May be NULL.
      */
     void setDrawable(Drawable* drawable);
 
@@ -680,25 +681,44 @@ class Node : public Transform, public Ref
 
 protected:
 
+    /** The scene this node is attached to. */
     Scene* _scene;
+    /** The nodes id. */
     std::string _id;
+    /** The nodes first child. */
     Node* _firstChild;
+    /** The nodes next sibiling. */
     Node* _nextSibling;
+    /** The nodes previous sibiling. */
     Node* _prevSibling;
+    /** The nodes parent. */
     Node* _parent;
+    /** The number of child nodes. */
     unsigned int _childCount;
+    /** If this node is enabled. Maybe different if parent is enabled/disabled. */
     bool _enabled; 
+    /** Tags assigned to this node. */
     std::map<std::string, std::string>* _tags;
+    /** The drawble component attached to this node. */
     Drawable* _drawable;
+    /** The camera component attached to this node. */
     Camera* _camera;
+    /** The light component attached to this node. */
     Light* _light;
+    /** The audio source component attached to this node. */
     AudioSource* _audioSource;
+    /** The collision object component attached to this node. */
     PhysicsCollisionObject* _collisionObject;
+    /** The AI agent component attached to this node. */
     mutable AIAgent* _agent;
+    /** The user object component attached to this node. */
     Ref* _userObject;
+    /** The world matrix for this node. */
     mutable Matrix _world;
-    mutable int _dirtyBits;
+    /** The bounding sphere for this node. */
     mutable BoundingSphere _bounds;
+    /** The dirty bits used for optimization. */
+    mutable int _dirtyBits;
 };
 
 /**