Working on documentation

Author: DanielChappuis

documentation/doxygen/Doxyfile.in

@@ -485,7 +485,7 @@ HIDE_UNDOC_CLASSES     = NO
 # included in the documentation.
 # The default value is: NO.
 
-HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_FRIEND_COMPOUNDS  = YES
 
 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
 # documentation blocks found inside the body of a function. If set to NO, these
@@ -774,7 +774,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @PROJECT_SOURCE_DIR@/"src/" @PROJECT_SOURCE_DIR@/"include/reactphysics3d/"
+INPUT                  = "@PROJECT_SOURCE_DIR@/include/reactphysics3d/"
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1010,7 +1010,7 @@ USE_HTAGS              = NO
 # See also: Section \class.
 # The default value is: YES.
 
-VERBATIM_HEADERS       = YES
+VERBATIM_HEADERS       = NO
 
 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the

documentation/sphinx/source/conf.py

@@ -16,16 +16,12 @@
 
 extensions = ["breathe"]
 
-templates_path = ['_templates']
 exclude_patterns = []
 
-
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
 
 # Breathe Configuration
 breathe_default_project = "ReactPhysics3D"

documentation/sphinx/source/index.rst

@@ -0,0 +1,31 @@
+.. ReactPhysics3D documentation master file, created by
+   sphinx-quickstart on Tue Mar 19 23:06:09 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+ReactPhysics3D
+==============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+User Manual
+===========
+
+
+.. include:: user_manual/user_manual.rst
+
+C++ API Reference
+=================
+
+.. doxygenindex::

documentation/sphinx/source/user_manual/user_manual.rst

@@ -0,0 +1,10 @@
+
+This is the user manual
+=======================
+
+  ============
+  Introduction
+  ============
+
+  ReactPhysics3D is an open source C++ physics engine library that can be used
+  in 3D simulations and games. The library is released under the ZLib license.

include/reactphysics3d/collision/shapes/ConcaveMeshShape.h

@@ -40,6 +40,9 @@ class TriangleShape;
 class TriangleMesh;
 
 // class ConvexTriangleAABBOverlapCallback
+/**
+ * This class represents a callback when an overlap occurs
+ */
 class ConvexTriangleAABBOverlapCallback : public DynamicAABBTreeOverlapCallback {
 
     private:

include/reactphysics3d/systems/BroadPhaseSystem.h

@@ -47,6 +47,9 @@ class MemoryManager;
 class Profiler;
 
 // class AABBOverlapCallback
+/**
+ * This class represents a callback when two AABB overlap
+ */
 class AABBOverlapCallback : public DynamicAABBTreeOverlapCallback {
 
     public:

src/collision/TriangleVertexArray.cpp

@@ -107,7 +107,9 @@ TriangleVertexArray::TriangleVertexArray(uint32 nbVertices, const void* vertices
 // Return the indices of the three vertices of a given triangle in the array
 /**
  * @param triangleIndex Index of a given triangle in the array
- * @param[out] outVerticesIndices Pointer to the three output vertex indices
+ * @param[out] outV1Index Index of the first vertex of the triangle in the vertex array
+ * @param[out] outV2Index Index of the first vertex of the triangle in the vertex array
+ * @param[out] outV3Index Index of the first vertex of the triangle in the vertex array
  */
 void TriangleVertexArray::getTriangleVerticesIndices(uint32 triangleIndex, uint32& outV1Index, uint32& outV2Index, uint32& outV3Index) const {
 
@@ -135,7 +137,7 @@ void TriangleVertexArray::getTriangleVerticesIndices(uint32 triangleIndex, uint3
 // Return a vertex of the array
 /**
  * @param vertexIndex Index of a given vertex of the array
- * @param[out] outVertex Pointer to the output vertex coordinates
+ * @return The vertex coordinates
  */
 Vector3 TriangleVertexArray::getVertex(uint32 vertexIndex) const {
 
@@ -162,7 +164,7 @@ Vector3 TriangleVertexArray::getVertex(uint32 vertexIndex) const {
 // Return a vertex normal of the array
 /**
  * @param vertexIndex Index of a given vertex of the array
- * @param[out] outNormal Pointer to the output vertex normal
+ * @return The normal vector of the vertex
  */
 Vector3 TriangleVertexArray::getVertexNormal(uint32 vertexIndex) const {