Nicer documentation

Doxyfile

@@ -768,7 +768,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = bin data mac_dist
+EXCLUDE                = bin data mac_dist test/greatest.h
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

include/Light.h

@@ -9,12 +9,18 @@
 
 #include <MatMath.h>
 
+/*!
+ * \brief The GL light class
+ */
 class Light {
 public:
+    /*!
+     * \brief Type a light can be of
+     */
     typedef enum {
-        typePoint = 1,
-        typeSpot = 2,
-        typeDirectional = 3
+        typePoint       = 1, //!< Point light
+        typeSpot        = 2, //!< Spot light
+        typeDirectional = 3  //!< Directional light
     } LightType;
 
     // These aren't used anywhere? -- xythobuz

include/OpenGLMesh.h

@@ -12,6 +12,9 @@
 
 #include <MatMath.h>
 
+/*!
+ * \brief OpenGL Mesh
+ */
 class OpenGLMesh {
 public:
 
@@ -78,10 +81,6 @@ public:
 
     } rect_t;
 
-    ////////////////////////////////////////////////////////////
-    // Constructors
-    ////////////////////////////////////////////////////////////
-
     /*!
      * \brief Constructs an object of OpenGLMesh
      */
@@ -92,83 +91,52 @@ public:
      */
     ~OpenGLMesh();
 
-
-    ////////////////////////////////////////////////////////////
-    // Public Accessors
-    ////////////////////////////////////////////////////////////
-
-
     void drawAlpha();
 
-
     void drawSolid();
 
-
-    ////////////////////////////////////////////////////////////
-    // Public Mutators
-    ////////////////////////////////////////////////////////////
-
-
     void allocateColors(unsigned int n);
 
-
     void allocateNormals(unsigned int n);
 
-
     void allocateRectangles(unsigned int n);
 
-
     void allocateTriangles(unsigned int n);
 
-
     void allocateVertices(unsigned int n);
 
-
     void bufferColorArray(unsigned int colorCount, vec_t *colors,
                                  unsigned int colorWidth);
 
-
     void bufferNormalArray(unsigned int normalCount, vec_t *normals);
 
-
     void bufferTriangles(unsigned int count,
                                 unsigned int *indices, vec_t *texCoords,
                                 int *textures, unsigned int *flags);
 
     void bufferVertexArray(unsigned int vertexCount, vec_t *vertices);
 
-
     void setColor(unsigned int index, float r, float g, float b, float a);
 
-
     void setColor(unsigned int index, float rgba[4]);
 
-
     void setNormal(unsigned int index, float i, float j, float k);
 
-
     void setVertex(unsigned int index, float x, float y, float z);
 
 #ifdef NOT_IMPLEMENTED
-
-
     void sortFacesByTexture();
 
-
     void addFace(int textureIndex, int textureIndexB, unsigned int flags,
                      unsigned int vertexIndexCount, vec_t *vertexIndices);
 
-
     void addTexTiledFace(int textureIndex, int textureIndexB,
                                 unsigned int flags, unsigned int indexCount,
                                 vec_t *vertexIndices, vec_t *texcoords);
 
-
     void bufferTexcoords(unsigned int texcoordCount, vec_t *texcoords);
 
-
     void duplicateArraysForTexTiledTexcoords();
-
 #endif
 
     unsigned int mFlags;
@@ -199,18 +167,6 @@ public:
     vec_t *mVertexArray;
     vec_t *mNormalArray;
     vec_t *mColorArray;
-
-private:
-
-    ////////////////////////////////////////////////////////////
-    // Private Accessors
-    ////////////////////////////////////////////////////////////
-
-
-    ////////////////////////////////////////////////////////////
-    // Private Mutators
-    ////////////////////////////////////////////////////////////
-
 };
 
 #endif

include/System.h

@@ -53,14 +53,8 @@ typedef enum {
 /*!
  * \brief Basic Interface for System implementations (SDLSystem)
  */
-class System
-{
+class System {
 public:
-
-    ////////////////////////////////////////////////////////////
-    // Constructors
-    ////////////////////////////////////////////////////////////
-
     /*!
      * \brief Constructs an object of System
      */
@@ -71,11 +65,6 @@ public:
      */
     virtual ~System();
 
-
-    ////////////////////////////////////////////////////////////
-    // Public Accessors
-    ////////////////////////////////////////////////////////////
-
     /*!
      * \brief Generates a buufered string for the printf call
      * \param string Format string like for printf
@@ -113,8 +102,7 @@ public:
      * \param size size of  buffer
      * \returns < 0 on error, 0 on success
      */
-    static int downloadToBuffer(char *urlString,
-                                         unsigned char **buffer, unsigned int *size);
+    static int downloadToBuffer(char *urlString, unsigned char **buffer, unsigned int *size);
 
     /*!
      * \brief Downloads something into a disk file.
@@ -132,11 +120,6 @@ public:
      */
     static int createDir(char *path);
 
-
-    ////////////////////////////////////////////////////////////
-    // Public Mutators
-    ////////////////////////////////////////////////////////////
-
     /*!
      * \brief Created a new Command Mode.
      * \param command valid command mode for the resource file, eg "[Engine.OpenGL.Driver]"
@@ -158,10 +141,8 @@ public:
      */
     virtual void command(const char *cmd);
 
-
     virtual void gameFrame() = 0;
 
-
     virtual void handleMouseMotionEvent(float x, float y) = 0;
 
     /*!
@@ -188,21 +169,15 @@ public:
      * \param key is a valid keyboard code
      * \param mod modifier key
      */
-    virtual void handleConsoleKeyPressEvent(unsigned int key,
-                                                         unsigned int mod) = 0;
-
+    virtual void handleConsoleKeyPressEvent(unsigned int key, unsigned int mod) = 0;
 
     virtual void handleKeyPressEvent(unsigned int key, unsigned int mod) = 0;
 
-
     virtual void handleKeyReleaseEvent(unsigned int key, unsigned int mod) = 0;
 
-
     virtual void initGL();
 
-
-    virtual void initVideo(unsigned int width, unsigned int height,
-                                  bool fullscreen) = 0;
+    virtual void initVideo(unsigned int width, unsigned int height, bool fullscreen) = 0;
 
     /*!
      * \brief Init the resource vars
@@ -211,13 +186,10 @@ public:
      */
     virtual int loadResourceFile(const char *filename);
 
-
     static void resetTicks();
 
-
     virtual void resizeGL(unsigned int width, unsigned int height);
 
-
     virtual void runGame() = 0;
 
     /*!
@@ -227,73 +199,56 @@ public:
      */
     void setConsoleMode(bool on);
 
-
     void setDriverGL(const char *driver);
 
-
     void setFastCardPerformance(bool isFast);
 
-
     virtual void shutdown(int code) = 0;
 
-
     virtual void swapBuffersGL() = 0;
 
-
     virtual void toggleFullscreen() = 0;
 
 protected:
-
-    unsigned int m_width; //!< Width of the viewport
-    unsigned int m_height; //!< Height of the viewport
-    bool m_fastCard; //!< Assume expensive calls are fine if true
-    char *m_driver; //!< String for dynamic use of GL library
-    float m_clipNear; //!< Clip near distance
-    float m_clipFar; //!< Clip far distance
-    float m_fovY; //!< Field of vision
+    unsigned int m_width;              //!< Width of the viewport
+    unsigned int m_height;             //!< Height of the viewport
+    bool m_fastCard;                   //!< Assume expensive calls are fine if true
+    char *m_driver;                    //!< String for dynamic use of GL library
+    float m_clipNear;                  //!< Clip near distance
+    float m_clipFar;                   //!< Clip far distance
+    float m_fovY;                      //!< Field of vision
     Map<unsigned int, int> mKeyEvents; //!< Single key press event mappings
-    bool mConsoleMode; //!< Using text (console) event handler?
-    Vector<const char *> mCmdModes; //!< Dynamic resource command collection
-    unsigned int mCommandMode; //!< Current resource command mode
-    unsigned int mConsoleKey; //!< Console toggle event now handled lower
-
-private:
-
-    ////////////////////////////////////////////////////////////
-    // Private Accessors
-    ////////////////////////////////////////////////////////////
-
-
-    ////////////////////////////////////////////////////////////
-    // Private Mutators
-    ////////////////////////////////////////////////////////////
+    bool mConsoleMode;                 //!< Using text (console) event handler?
+    Vector<const char *> mCmdModes;    //!< Dynamic resource command collection
+    unsigned int mCommandMode;         //!< Current resource command mode
+    unsigned int mConsoleKey;          //!< Console toggle event now handled lower
 };
 
 
 //! \todo Could make these static methods later, depends on API evolution
 
-    /*!
-     * \brief Checks if Command matches Symbol.
-     * Returns the rest of the argument list back in command buffer, if any
-     * \param symbol command string
-     * \param command with arguments
-     * \returns true if command matches symbol
-     */
-    bool rc_command(const char *symbol, char *command);
+/*!
+ * \brief Checks if Command matches Symbol.
+ * Returns the rest of the argument list back in command buffer, if any
+ * \param symbol command string
+ * \param command with arguments
+ * \returns true if command matches symbol
+ */
+bool rc_command(const char *symbol, char *command);
 
-    /*!
-     * \brief Interpret a string as a bool
-     * \param buffer "true" or "false"
-     * \param val is set to boolean interpretation of buffer
-     * \returns -1 for null string, -2 if string is not "true" or "false"
-     */
-    int rc_get_bool(char *buffer, bool *val);
+/*!
+ * \brief Interpret a string as a bool
+ * \param buffer "true" or "false"
+ * \param val is set to boolean interpretation of buffer
+ * \returns -1 for null string, -2 if string is not "true" or "false"
+ */
+int rc_get_bool(char *buffer, bool *val);
 
-    /*!
-     * \brief Sets timer state and returns number of ticks
-     * \param state 0 - reset, 1 - get number of ticks
-     * \returns number of ticks
-     */
-    unsigned int system_timer(int state);
+/*!
+ * \brief Sets timer state and returns number of ticks
+ * \param state 0 - reset, 1 - get number of ticks
+ * \returns number of ticks
+ */
+unsigned int system_timer(int state);
 
 #endif