Merge pull request cocos2d#12080 from linshun/v3

issue cocos2d#12078 added audio, network, physics, platform and storage group.
fumingxing2015 · Jun 15, 2015 · d0db40c · d0db40c
2 parents 707e9d4 + c54d4ba
commit d0db40c
Show file tree

Hide file tree

Showing 36 changed files with 65 additions and 38 deletions.
diff --git a/cocos/audio/include/AudioEngine.h b/cocos/audio/include/AudioEngine.h
@@ -41,7 +41,7 @@
 #endif // ERROR
 
 /**
- * @addtogroup core
+ * @addtogroup audio
  * @{
  */
 

diff --git a/cocos/audio/include/SimpleAudioEngine.h b/cocos/audio/include/SimpleAudioEngine.h
@@ -38,7 +38,7 @@ THE SOFTWARE.
 #endif
 
 /**
-* @addtogroup core
+* @addtogroup audio
 * @{
 */
 

diff --git a/cocos/network/HttpClient.h b/cocos/network/HttpClient.h
@@ -36,7 +36,7 @@
 #include "network/HttpCookie.h"
 
 /**
- * @addtogroup core
+ * @addtogroup network
  * @{
  */
 

diff --git a/cocos/network/HttpRequest.h b/cocos/network/HttpRequest.h
@@ -32,7 +32,7 @@
 #include "base/ccMacros.h"
 
 /**
- * @addtogroup core
+ * @addtogroup network
  * @{
  */
 

diff --git a/cocos/network/HttpResponse.h b/cocos/network/HttpResponse.h
@@ -29,7 +29,7 @@
 #include "network/HttpRequest.h"
 
 /**
- * @addtogroup core
+ * @addtogroup network
  * @{
  */
 

diff --git a/cocos/network/SocketIO.h b/cocos/network/SocketIO.h
@@ -65,7 +65,7 @@ in the onClose method the pointer should be set to NULL or used to connect to a
 #include <string>
 
 /**
- * @addtogroup core
+ * @addtogroup network
  * @{
  */
 

diff --git a/cocos/network/WebSocket.h b/cocos/network/WebSocket.h
@@ -41,7 +41,7 @@ struct libwebsocket_context;
 struct libwebsocket_protocols;
 
 /**
- * @addtogroup core
+ * @addtogroup network
  * @{
  */
 

diff --git a/cocos/physics/CCPhysicsBody.h b/cocos/physics/CCPhysicsBody.h
@@ -48,7 +48,9 @@ typedef Vec2 Vect;
 const PhysicsMaterial PHYSICSBODY_MATERIAL_DEFAULT(0.1f, 0.5f, 0.5f);
 
 /**
- * @addtogroup core
+ * @addtogroup physics
+ * @{
+ * @addtogroup physics_2d
  * @{
  */
 
@@ -560,6 +562,8 @@ class CC_DLL PhysicsBody : public Ref
 };
 
 /** @} */
+/** @} */
+
 
 NS_CC_END
 

diff --git a/cocos/physics/CCPhysicsContact.h b/cocos/physics/CCPhysicsContact.h
@@ -55,7 +55,9 @@ typedef struct CC_DLL PhysicsContactData
 }PhysicsContactData;
 
 /**
- * @addtogroup core
+ * @addtogroup physics
+ * @{
+ * @addtogroup physics_2d
  * @{
  */
 
@@ -307,6 +309,7 @@ class CC_DLL EventListenerPhysicsContactWithGroup : public EventListenerPhysicsC
     virtual ~EventListenerPhysicsContactWithGroup();
 };
 
+/** @} */
 /** @} */
 
 NS_CC_END

diff --git a/cocos/physics/CCPhysicsHelper.h b/cocos/physics/CCPhysicsHelper.h
@@ -35,7 +35,9 @@
 NS_CC_BEGIN
 
 /**
- * @addtogroup core
+ * @addtogroup physics
+ * @{
+ * @addtogroup physics_2d
  * @{
  */
 
@@ -108,6 +110,7 @@ class PhysicsHelper
     }
 };
 
+/** @} */
 /** @} */
 
 NS_CC_END

diff --git a/cocos/physics/CCPhysicsJoint.h b/cocos/physics/CCPhysicsJoint.h
@@ -40,7 +40,9 @@ class PhysicsBody;
 class PhysicsWorld;
 
 /**
- * @addtogroup core
+ * @addtogroup physics
+ * @{
+ * @addtogroup physics_2d
  * @{
  */
 
@@ -567,6 +569,8 @@ class CC_DLL PhysicsJointMotor : public PhysicsJoint
 };
 
 /** @} */
+/** @} */
+
 
 NS_CC_END
 

diff --git a/cocos/physics/CCPhysicsShape.h b/cocos/physics/CCPhysicsShape.h
@@ -59,8 +59,11 @@ typedef struct CC_DLL PhysicsMaterial
 const PhysicsMaterial PHYSICSSHAPE_MATERIAL_DEFAULT;
 
 /**
- *  @addtogroup core
+ *  @addtogroup physics
  *  @{
+ *  @addtogroup physics_2d
+ *  @{
+
  */
 
 /**
@@ -718,6 +721,7 @@ class CC_DLL PhysicsShapeEdgeChain : public PhysicsShape
     friend class PhysicsBody;
 };
 
+/** @} */
 /** @} */
 
 NS_CC_END

diff --git a/cocos/physics/CCPhysicsWorld.h b/cocos/physics/CCPhysicsWorld.h
@@ -80,7 +80,9 @@ typedef std::function<bool(PhysicsWorld&, PhysicsShape&, void*)> PhysicsQueryRec
 typedef PhysicsQueryRectCallbackFunc PhysicsQueryPointCallbackFunc;
 
 /**
- * @addtogroup core
+ * @addtogroup physics
+ * @{
+ * @addtogroup physics_2d
  * @{
  */
 
@@ -415,6 +417,8 @@ class CC_DLL PhysicsDebugDraw
 extern const float CC_DLL PHYSICS_INFINITY;
 
 /** @} */
+/** @} */
+
 NS_CC_END
 
 #endif // CC_USE_PHYSICS

diff --git a/cocos/platform/CCApplicationProtocol.h b/cocos/platform/CCApplicationProtocol.h
@@ -33,7 +33,7 @@ THE SOFTWARE.
 NS_CC_BEGIN
 
 /**
- * @addtogroup core
+ * @addtogroup platform
  * @{
  */
 

diff --git a/cocos/platform/CCDevice.h b/cocos/platform/CCDevice.h
@@ -35,7 +35,7 @@ NS_CC_BEGIN
 struct FontDefinition;
 
 /**
- * @addtogroup support
+ * @addtogroup platform
  * @{
  */
 

diff --git a/cocos/platform/CCFileUtils.h b/cocos/platform/CCFileUtils.h
@@ -37,7 +37,7 @@ THE SOFTWARE.
 NS_CC_BEGIN
 
 /**
- * @addtogroup support
+ * @addtogroup platform
  * @{
  */
 

diff --git a/cocos/platform/CCGLView.h b/cocos/platform/CCGLView.h
@@ -87,7 +87,7 @@ struct GLContextAttrs
 NS_CC_BEGIN
 
 /**
- * @addtogroup core
+ * @addtogroup platform
  * @{
  */
 /**

diff --git a/cocos/renderer/CCBatchCommand.h b/cocos/renderer/CCBatchCommand.h
@@ -28,7 +28,7 @@
 #include "renderer/CCRenderCommand.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCCustomCommand.h b/cocos/renderer/CCCustomCommand.h
@@ -29,7 +29,7 @@
 #include "renderer/CCRenderCommand.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCGLProgram.h b/cocos/renderer/CCGLProgram.h
@@ -40,7 +40,7 @@ THE SOFTWARE.
 #include "math/CCMath.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCGLProgramCache.h b/cocos/renderer/CCGLProgramCache.h
@@ -34,7 +34,7 @@ THE SOFTWARE.
 #include "base/CCRef.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCGLProgramState.h b/cocos/renderer/CCGLProgramState.h
@@ -36,7 +36,7 @@ THE SOFTWARE.
 #include "math/Vec4.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCGLProgramStateCache.h b/cocos/renderer/CCGLProgramStateCache.h
@@ -33,7 +33,7 @@ THE SOFTWARE.
 #include "math/Vec4.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCGroupCommand.h b/cocos/renderer/CCGroupCommand.h
@@ -33,7 +33,7 @@
 #include "CCRenderCommand.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCPrimitive.h b/cocos/renderer/CCPrimitive.h
@@ -28,7 +28,7 @@
 #include "renderer/CCVertexIndexData.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCPrimitiveCommand.h b/cocos/renderer/CCPrimitiveCommand.h
@@ -29,7 +29,7 @@
 #include "renderer/CCRenderCommand.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCQuadCommand.h b/cocos/renderer/CCQuadCommand.h
@@ -29,7 +29,7 @@
 #include "renderer/CCGLProgramState.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCRenderCommand.h b/cocos/renderer/CCRenderCommand.h
@@ -32,7 +32,7 @@
 #include "base/ccTypes.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCRenderer.h b/cocos/renderer/CCRenderer.h
@@ -35,7 +35,7 @@
 #include "platform/CCGL.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCTrianglesCommand.h b/cocos/renderer/CCTrianglesCommand.h
@@ -29,7 +29,7 @@
 #include "renderer/CCGLProgramState.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCVertexIndexBuffer.h b/cocos/renderer/CCVertexIndexBuffer.h
@@ -30,7 +30,7 @@
 #include "platform/CCGL.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/CCVertexIndexData.h b/cocos/renderer/CCVertexIndexData.h
@@ -29,7 +29,7 @@
 #include <map>
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/ccGLStateCache.h b/cocos/renderer/ccGLStateCache.h
@@ -36,7 +36,7 @@ THE SOFTWARE.
 NS_CC_BEGIN
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/renderer/ccShaders.h b/cocos/renderer/ccShaders.h
@@ -32,7 +32,7 @@ THE SOFTWARE.
 #include "platform/CCPlatformMacros.h"
 
 /**
- * @addtogroup support
+ * @addtogroup renderer
  * @{
  */
 

diff --git a/cocos/storage/local-storage/LocalStorage.h b/cocos/storage/local-storage/LocalStorage.h
@@ -30,7 +30,7 @@ THE SOFTWARE.
 #include "CCPlatformMacros.h"
 
 /**
- * @addtogroup core
+ * @addtogroup storage
  * @{
  */
 

diff --git a/docs/Groups.h b/docs/Groups.h
@@ -1,10 +1,15 @@
 /**
-@defgroup actions           Actions
 @defgroup _2d               2D Nodes
 @defgroup _3d               3D Nodes
-@defgroup core              Core
+@defgroup actions           Actions
+@defgroup audio             Audio
 @defgroup base              Base
-@defgroup support           Support
+@defgroup network           Network
+@defgroup physics           Physics
+@defgroup physics_2d        Physics 2D
+@defgroup platform          Platform Specific
+@defgroup renderer          Renderer
+@defgroup storage           Storage
 @defgroup ui                UI Nodes
 @defgroup lua               Lua Binding
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -41,7 +41,7 @@ @@
     #endif // ERROR
     /**
-     * @addtogroup core
+     * @addtogroup audio
      * @{
      */
@@ Expand Down @@