Merge pull request #11196 from tangziwen/doc

3d fix doxygen add to group

cocos/3d/CCAABB.h

@@ -30,6 +30,11 @@
 
 NS_CC_BEGIN
 
+/**
+ * @addtogroup _3d
+ * @{
+ */
+
 /**
  * Axis Aligned Bounding Box (AABB), usually caculate some rough but fast collision detection.
  */
@@ -117,6 +122,9 @@ public:
     Vec3 _max;
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif

cocos/3d/CCAnimate3D.h

@@ -37,8 +37,14 @@ NS_CC_BEGIN
 
 class Bone3D;
 class Sprite3D;
+
 /**
- * Animate3D, Animates a Sprite3D given with an Animation3D
+ * @addtogroup _3d
+ * @{
+ */
+
+/**
+ * @brief Animate3D, Animates a Sprite3D given with an Animation3D
  */
 class CC_DLL Animate3D: public ActionInterval
 {
@@ -139,6 +145,9 @@ protected:
     static std::unordered_map<Sprite3D*, Animate3D*> s_runningAnimates;
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif // __CCANIMATE3D_H__

cocos/3d/CCAnimation3D.h

@@ -34,9 +34,13 @@
 #include "3d/CCBundle3DData.h"
 
 NS_CC_BEGIN
+/**
+ * @addtogroup _3d
+ * @{
+ */
 
 /**
- * static animation data, shared
+ * @brief static animation data, shared
  */
 class CC_DLL Animation3D: public Ref
 {
@@ -114,6 +118,8 @@ protected:
     std::unordered_map<std::string, Animation3D*> _animations; //cached animations
 };
 
+// end of actions group
+/// @}
 NS_CC_END
 
 #endif // __CCANIMATION3D_H__

cocos/3d/CCAnimationCurve.h

@@ -36,6 +36,11 @@
 
 NS_CC_BEGIN
 
+/**
+ * @addtogroup _3d
+ * @{
+ */
+
 /**
  * Evaluate Type
  */
@@ -48,7 +53,7 @@ enum class EvaluateType
 };
 
 /**
- * curve of bone's position, rotation or scale
+ * @brief curve of bone's position, rotation or scale
  */
 template <int componentSize>
 class AnimationCurve: public Ref
@@ -95,6 +100,9 @@ protected:
     std::function<void(float time, float* dst)> _evaluateFun; //user defined function
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #include "CCAnimationCurve.inl"

cocos/3d/CCAttachNode.h

@@ -29,11 +29,14 @@
 #include "2d/CCNode.h"
 
 NS_CC_BEGIN
-
+/**
+ * @addtogroup _3d
+ * @{
+ */
 class Bone3D;
 
 /** 
- * attach a node to a bone
+ * @brief attach a node to a bone
  * usage: auto sprite = Sprite3D::create("girl.c3b");
  *        auto weapon = Sprite3D::create("weapon.c3b");
  *        auto attachNode = sprite->getAttachNode("left hand");
@@ -65,6 +68,8 @@ protected:
     mutable Mat4    _transformToParent;
 };
 
+// end of actions group
+/// @}
 
 NS_CC_END
 #endif // __CCATTACHNODE_H__

cocos/3d/CCBillBoard.h

@@ -28,9 +28,13 @@
 #include "2d/CCSprite.h"
 
 NS_CC_BEGIN
+/**
+ * @addtogroup _3d
+ * @{
+ */
 
 /**
- * Inherit from Sprite, achieve BillBoard.
+ * @brief Inherit from Sprite, achieve BillBoard.
  */
 class CC_DLL BillBoard : public Sprite
 {
@@ -118,7 +122,8 @@ private:
 
 };
 
-
+// end of actions group
+/// @}
 
 NS_CC_END
 

cocos/3d/CCBundle3D.h

@@ -30,11 +30,17 @@
 #include "json/document.h"
 
 NS_CC_BEGIN
+
+/**
+ * @addtogroup _3d
+ * @{
+ */
+
 class Animation3D;
 class Data;
 
 /**
- * Defines a bundle file that contains a collection of assets. Mesh, Material, MeshSkin, Animation
+ * @brief Defines a bundle file that contains a collection of assets. Mesh, Material, MeshSkin, Animation
  * There are two types of bundle files, c3t and c3b.
  * c3t text file
  * c3b binary file
@@ -174,6 +180,9 @@ protected:
     bool  _isBinary;
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif // __CCBUNDLE3D_H__

cocos/3d/CCBundleReader.h

@@ -35,7 +35,12 @@
 NS_CC_BEGIN
 
 /**
- * BundleReader is an interface for reading sequence of bytes.
+ * @addtogroup _3d
+ * @{
+ */
+
+/**
+ * @brief BundleReader is an interface for reading sequence of bytes.
  */
 class BundleReader: public cocos2d::Ref
 {
@@ -201,6 +206,8 @@ inline bool BundleReader::readArray<std::string>(unsigned int *length, std::vect
     return true;
 }
 
+// end of actions group
+/// @}
 
 NS_CC_END
 

cocos/3d/CCMesh.h

@@ -36,13 +36,18 @@
 
 NS_CC_BEGIN
 
+/**
+ * @addtogroup _3d
+ * @{
+ */
+
 class Texture2D;
 class MeshSkin;
 class MeshIndexData;
 class GLProgramState;
 class GLProgram;
 /** 
- * Mesh: contains ref to index buffer, GLProgramState, texture, skin, blend function, aabb and so on
+ * @brief Mesh: contains ref to index buffer, GLProgramState, texture, skin, blend function, aabb and so on
  */
 class CC_DLL Mesh : public Ref
 {
@@ -158,6 +163,10 @@ protected:
     std::function<void()> _visibleChanged;
 };
 
+// end of actions group
+/// @}
+
+
 NS_CC_END
 
 #endif // __CCMESH_H__

cocos/3d/CCMeshSkin.h

@@ -33,11 +33,16 @@
 
 NS_CC_BEGIN
 
+/**
+ * @addtogroup _3d
+ * @{
+ */
+
 class Bone3D;
 class Skeleton3D;
 
 /**
- * MeshSkin, A class maintain a collection of bones that affect Mesh vertex.
+ * @brief MeshSkin, A class maintain a collection of bones that affect Mesh vertex.
  * And it is responsible for computing matrix palletes that used by skin mesh rendering.
  */
 class CC_DLL MeshSkin: public Ref
@@ -99,6 +104,9 @@ protected:
     Vec4* _matrixPalette;
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif // __CCSKIN_H__

cocos/3d/CCMeshVertexIndexData.h

@@ -41,6 +41,11 @@
 
 NS_CC_BEGIN
 
+/**
+ * @addtogroup _3d
+ * @{
+ */
+
 class MeshVertexData;
 
 /**
@@ -132,6 +137,9 @@ protected:
     int                  _vertexCount; //vertex count
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif // __CCMESHVERTEXINDEXDATA_H__

cocos/3d/CCOBB.h

@@ -29,6 +29,11 @@
 
 NS_CC_BEGIN
 
+/**
+ * @addtogroup _3d
+ * @{
+ */
+
 /**
  * Oritened Bounding Box(OBB)
  * @brief the OBB is similar to the AABB but the bounding box has the same direction as Sprite3D. so it's collistion detection more precise than AABB
@@ -129,6 +134,9 @@ public:
     Vec3 _extents;  // obb length along each axis
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif

cocos/3d/CCObjLoader.h

@@ -17,7 +17,12 @@
 NS_CC_BEGIN
 
 /**
- * .obj file Loader
+ * @addtogroup _3d
+ * @{
+ */
+
+/**
+ * @brief .obj file Loader
  **/
 class ObjLoader
 {
@@ -100,6 +105,9 @@ public:
 
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif  // _TINY_OBJ_LOADER_H

cocos/3d/CCRay.h

@@ -33,7 +33,12 @@
 NS_CC_BEGIN
 
 /**
- * Ray is a line with one end. usually use it to check intersects with some object,such as Plane, OBB, AABB
+ * @addtogroup _3d
+ * @{
+ */
+
+/**
+ * @brief Ray is a line with one end. usually use it to check intersects with some object,such as Plane, OBB, AABB
  **/
 class CC_DLL Ray
 {
@@ -93,6 +98,9 @@ public:
     Vec3 _direction;     // The ray direction vector.
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif

cocos/3d/CCSkeleton3D.h

@@ -33,7 +33,12 @@
 NS_CC_BEGIN
 
 /**
- * Defines a basic hierachial structure of transformation spaces.
+ * @addtogroup _3d
+ * @{
+ */
+
+/**
+ * @brief Defines a basic hierachial structure of transformation spaces.
  */
 class CC_DLL Bone3D : public Ref
 {
@@ -226,6 +231,9 @@ protected:
     Vector<Bone3D*> _rootBones;
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif // __CCSKELETON3D_H__

cocos/3d/CCSprite3D.h

@@ -41,12 +41,17 @@
 
 NS_CC_BEGIN
 
+/**
+ * @addtogroup _3d
+ * @{
+ */
+
 class Mesh;
 class Texture2D;
 class MeshSkin;
 class AttachNode;
 struct NodeData;
-/** Sprite3D: A sprite can be loaded from 3D model files, .obj, .c3t, .c3b, then can be drawed as sprite */
+/** @brief Sprite3D: A sprite can be loaded from 3D model files, .obj, .c3t, .c3b, then can be drawed as sprite */
 class CC_DLL Sprite3D : public Node, public BlendProtocol
 {
 public:
@@ -286,5 +291,8 @@ protected:
 
 extern std::string CC_DLL s_attributeNames[];//attribute names array
 
+// end of actions group
+/// @}
+
 NS_CC_END
 #endif // __SPRITE3D_H_

cocos/3d/CCSprite3DMaterial.h

@@ -31,10 +31,15 @@
 
 NS_CC_BEGIN
 
+/**
+ * @addtogroup _3d
+ * @{
+ */
+
 class Texture2D;
 
 /**
- * the sprite3D material is only texture for now
+ * @brief the sprite3D material is only texture for now
  */
 class Sprite3DMaterialCache
 {
@@ -65,6 +70,9 @@ protected:
     
 };
 
+// end of actions group
+/// @}
+
 NS_CC_END
 
 #endif // __CCSPRIT3DMATERIAL_H__