Working on documentation

Author: DanielChappuis

documentation/README.md

@@ -8,8 +8,12 @@
   - Doxygen
   - Sphinx
   - Breathe (bridge between Doxygen and Sphinx)
+  - Exhale (used to better display the API documentation from Doxygen)
   - CMake
 
  # How to generate the documentation
 
+  1. First, we need to configure CMake to generate the documentation by enabling the RP3D_GENERATE_DOCUMENTATION option
+  2. The simply run 'make' to generate the documentation
+
 

documentation/doxygen/Doxyfile.in

@@ -152,7 +152,7 @@ FULL_PATH_NAMES        = YES
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        =
+STRIP_FROM_PATH        = 
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
@@ -161,7 +161,7 @@ STRIP_FROM_PATH        =
 # specify the list of include paths that are normally passed to the compiler
 # using the -I flag.
 
-STRIP_FROM_INC_PATH    =
+STRIP_FROM_INC_PATH    = "../../"
 
 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
 # less readable) file names. This can be useful is your file systems doesn't
@@ -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@/include/reactphysics3d/"
+INPUT                  = "@PROJECT_SOURCE_DIR@/include/reactphysics3d/" "@PROJECT_SOURCE_DIR@/src/"
 
 # 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

documentation/sphinx/source/conf.py

@@ -6,15 +6,22 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+# read version from ../VERSION
+version = open('../../../VERSION').readlines()[0]
+# The full version, including alpha/beta/rc tags.
+
+# The master toctree document.
+master_doc = 'index'
+
 project = 'ReactPhysics3D'
 copyright = '2024, Daniel Chappuis'
 author = 'Daniel Chappuis'
-release = 'v0.10.0'
+release = "v" + version
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["breathe"]
+extensions = ["breathe", "exhale"]
 
 exclude_patterns = []
 
@@ -26,4 +33,21 @@
 # Breathe Configuration
 breathe_default_project = "ReactPhysics3D"
 
+# Setup the exhale extension
+exhale_args = {
+    # These arguments are required
+    "containmentFolder":     "./api",
+    "rootFileName":          "library_root.rst",
+    "doxygenStripFromPath":  "../../../",
+    # Heavily encouraged optional argument (see docs)
+    "rootFileTitle":         "C++ API Reference",
+    "afterTitleDescription":         "This section describes the API of the library.",
+    # Suggested optional arguments
+    "createTreeView":        True,
+    "exhaleExecutesDoxygen": False,
+}
+
+# Tell sphinx what the primary language being documented is.
+primary_domain = 'cpp'
+
 highlight_language = 'c++'

documentation/sphinx/source/index.rst

@@ -8,24 +8,6 @@ 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::
+   introduction
+   api/library_root

documentation/sphinx/source/user_manual/user_manual.rst

@@ -36,9 +36,8 @@ using namespace reactphysics3d;
 
 // Constructor
 /**
- * @param transform The transform of the body
- * @param world The physics world where the body is created
- * @param id ID of the body
+ * @param world The reference to the physics world where the body is created
+ * @param entity Entity of the body
  */
 Body::Body(PhysicsWorld& world, Entity entity)
               : mEntity(entity), mWorld(world), mIsDebugEnabled(false)  {
@@ -133,8 +132,8 @@ uint32 Body::getNbColliders() const {
 
 // Return a const pointer to a given collider of the body
 /**
-* @param index Index of a Collider of the body
-* @return The const pointer of a given collider of the body
+* @param colliderIndex Index of a Collider of the body
+* @return The const pointer to the requested collider
 */
 const Collider* Body::getCollider(uint32 colliderIndex) const {
 
@@ -147,8 +146,8 @@ const Collider* Body::getCollider(uint32 colliderIndex) const {
 
 // Return a pointer to a given collider of the body
 /**
-* @param index Index of a Collider of the body
-* @return The pointer of a given collider of the body
+* @param colliderIndex Index of a Collider of the body
+* @return The pointer to the requested collider
 */
 Collider* Body::getCollider(uint32 colliderIndex) {