This commit performs a comprehensive documentation pass on the MedicalLib library, implementing a full documentation generation pipeline using Doxygen, Sphinx, and Breathe for Read the Docs.

Key changes include:

- **Added Comprehensive Doxygen Comments:**
  - Reviewed all header files in `include/MedicalLib/`.
  - Added Doxygen comments for public methods, structs, and their member variables to ensure full API coverage as per the project's coding standards.
  - Addressed all Doxygen warnings related to undocumented public members.

- **Restructured Sphinx Documentation:**
  - Created a new `docs/api/` directory to house detailed documentation for each component.
  - Replaced the single `api.rst` file with a well-organized structure using a `toctree`.
  - Created individual `.rst` pages for each organ, class, and major component.

- **Enabled Graph Generation:**
  - Configured Doxygen to generate class hierarchy and collaboration graphs.
  - Ensured the build process includes these graphs in the final documentation, providing visual context for the library's structure.

- **Verified Build Process:**
  - Installed all necessary dependencies (`doxygen`, `graphviz`, python packages).
  - Successfully ran the Doxygen and Sphinx build process to generate the final HTML documentation, ensuring all changes are correctly integrated.

This work results in a professional, navigable, and maintainable documentation site for the MedicalLib library.
This commit is contained in:
google-labs-jules[bot]
2025-08-20 09:14:51 +00:00
parent ec4064f759
commit 86488cec48
29 changed files with 375 additions and 59 deletions
+3 -3
View File
@@ -8,9 +8,9 @@
* @brief Represents a functional unit of the kidney.
*/
struct Nephron {
std::string id;
double filtrationEfficiency; // 0.0 to 1.0
bool isDamaged;
std::string id; ///< The unique ID of the nephron.
double filtrationEfficiency; ///< The filtration efficiency, normalized [0.0, 1.0].
bool isDamaged; ///< True if the nephron has sustained damage.
};
/**