Changeset 11099 for code/trunk/src/libraries/tools

Timestamp:

Jan 27, 2016, 6:50:51 PM (9 years ago)

Author:

muemart

Message:

Fix loads of doxygen warnings and other documentation issues

Location:

code/trunk/src/libraries/tools

Files:

• BulletDebugDrawer.cc (modified) (1 diff)
• BulletDebugDrawer.h (modified) (2 diffs)
• DebugDrawer.cc (modified) (1 diff)
• DebugDrawer.h (modified) (3 diffs)
• IcoSphere.cc (modified) (1 diff)
• IcoSphere.h (modified) (2 diffs)
• OgreBulletUtils.h (modified) (1 diff)

code/trunk/src/libraries/tools/BulletDebugDrawer.cc

@@ -1 +1 @@
 /**
+ * @file BulletDebugDrawer.cc
  * Originally from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
  * This source code is released into the Public Domain.

code/trunk/src/libraries/tools/BulletDebugDrawer.h

@@ -1 @@
-/**
- * Originally from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
- * This source code is released into the Public Domain.
- *
- * Modified by Fabian 'x3n' Landau by using DebugDrawer and Orxonox specific utilities (e.g. output).
- */
-
 #ifndef _BulletDebugDrawer_H__
 #define _BulletDebugDrawer_H__
@@ -18 +11 @@
 namespace orxonox
 {
+    /**
+    * Originally from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
+    * This source code is released into the Public Domain.
+    *
+    * Modified by Fabian 'x3n' Landau by using DebugDrawer and Orxonox specific utilities (e.g. output).
+    */
     class _ToolsExport BulletDebugDrawer : public btIDebugDraw, public Ogre::FrameListener
     {

code/trunk/src/libraries/tools/DebugDrawer.cc

@@ -1 +1 @@
 /**
+ * @file DebugDrawer.cc
  * Copy-pasted from
  *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src

code/trunk/src/libraries/tools/DebugDrawer.h

@@ -1 +1 @@
 /**
+ * @file DebugDrawer.h
  * Copy-pasted from
  *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
@@ -9 +10 @@
  */
 
-/**
- * @file
- * @brief DebugDrawer is a utility to draw debug shapes (lines, triangles, spheres) with Ogre.
- * This utility is e.g. used by @ref BulletDebugDrawer to visualize collision shapes and other physical entities.
- */
+
 
 #ifndef _DebugDrawer_H__
@@ -26 +23 @@
 namespace orxonox
 {
+    /**
+     * @brief DebugDrawer is a utility to draw debug shapes (lines, triangles, spheres) with Ogre.
+     * This utility is e.g. used by @ref orxonox::BulletDebugDrawer to visualize collision shapes and other physical entities.
+     */
     class _ToolsExport DebugDrawer
     {

code/trunk/src/libraries/tools/IcoSphere.cc

@@ -1 +1 @@
 /**
+ * @file IcoSphere.cc
  * Copy-pasted from
  *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src

code/trunk/src/libraries/tools/IcoSphere.h

@@ -1 @@
-/**
- * Copy-pasted from
- *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
- *  - http://www.ogre3d.org/tikiwiki/tiki-index.php?page=Debug+Drawing+Utility+Class
- *
- * This source code is released into the Public Domain.
- *
- * Modified by Fabian 'x3n' Landau
- */
 
-/**
- * @file
- * @brief DebugDrawer is a utility to draw debug shapes (lines, triangles, spheres) with Ogre.
- * This utility is e.g. used by @ref BulletDebugDrawer to visualize collision shapes and other physical entities.
- */
 
 #ifndef _IcoSphere_H__
@@ -27 +13 @@
     typedef std::pair<Ogre::Vector3, Ogre::ColourValue> VertexPair;
 
+    /**
+    * Copy-pasted from
+    *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
+    *  - http://www.ogre3d.org/tikiwiki/tiki-index.php?page=Debug+Drawing+Utility+Class
+    *
+    * This source code is released into the Public Domain.
+    *
+    * Modified by Fabian 'x3n' Landau
+    */
     class _ToolsExport IcoSphere
     {

code/trunk/src/libraries/tools/OgreBulletUtils.h

@@ -1 +1 @@
 /**
+ * @file OgreBulletUtils.h
  * Copy-pasted from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
  * This source code is released into the Public Domain.