ソースを参照

Update documentation of some physics objects

Daniele Bartolini 12 年 前
コミット
7c2544bdaa

+ 2 - 0
engine/physics/Actor.h

@@ -56,6 +56,8 @@ struct Matrix4x4;
 struct Unit;
 struct Unit;
 class SceneGraph;
 class SceneGraph;
 
 
+///
+/// @ingroup Physics
 struct Actor
 struct Actor
 {
 {
 	/// Constructor
 	/// Constructor

+ 2 - 0
engine/physics/Controller.h

@@ -44,6 +44,8 @@ struct Vector3;
 class SceneGraph;
 class SceneGraph;
 class PhysicsControllerCallback;
 class PhysicsControllerCallback;
 
 
+///
+/// @ingroup Physics
 struct Controller
 struct Controller
 {
 {
 							Controller(const PhysicsResource* pr, SceneGraph& sg, int32_t node, PxPhysics* physics, PxControllerManager* manager);
 							Controller(const PhysicsResource* pr, SceneGraph& sg, int32_t node, PxPhysics* physics, PxControllerManager* manager);

+ 2 - 1
engine/physics/Joint.h

@@ -44,7 +44,8 @@ namespace crown
 struct PhysicsResource;
 struct PhysicsResource;
 class Actor;
 class Actor;
 
 
-//-----------------------------------------------------------------------------
+///
+/// @ingroup Physics
 struct Joint
 struct Joint
 {
 {
 	Joint(PxPhysics* physics, const PhysicsResource* pr, const uint32_t index, const Actor& actor_0, const Actor& actor_1);
 	Joint(PxPhysics* physics, const PhysicsResource* pr, const uint32_t index, const Actor& actor_0, const Actor& actor_1);

+ 5 - 1
engine/physics/PhysicsWorld.h

@@ -48,6 +48,8 @@ using physx::PxOverlapBuffer;
 namespace crown
 namespace crown
 {
 {
 
 
+/// @defgroup Physics Physics
+
 /// Global physics-related functions
 /// Global physics-related functions
 namespace physics_system
 namespace physics_system
 {
 {
@@ -73,7 +75,9 @@ struct Raycast;
 struct Unit;
 struct Unit;
 struct Vector3;
 struct Vector3;
 
 
-//-----------------------------------------------------------------------------
+/// Manages physics objects in a World.
+///
+/// @ingroup Physics
 class PhysicsWorld
 class PhysicsWorld
 {
 {
 public:
 public:

+ 4 - 2
engine/physics/Raycast.h

@@ -46,7 +46,8 @@ namespace crown
 struct Vector3;
 struct Vector3;
 struct Actor;
 struct Actor;
 
 
-//-----------------------------------------------------------------------------
+///
+/// @ingroup Physics
 struct RaycastHit
 struct RaycastHit
 {
 {
 	Vector3					position;
 	Vector3					position;
@@ -55,7 +56,8 @@ struct RaycastHit
 	Actor*					actor;
 	Actor*					actor;
 };
 };
 
 
-//-----------------------------------------------------------------------------
+///
+/// @ingroup Physics
 struct Raycast
 struct Raycast
 {
 {
 	/// Constructor
 	/// Constructor