Files
medicallib/docs/api/patient.rst
T
google-labs-jules[bot] 86488cec48 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.
2025-08-20 09:14:51 +00:00

27 lines
482 B
ReStructuredText

Patient
=======
This page documents the main `Patient` struct and related functions that manage the overall simulation state.
.. doxygenstruct:: Patient
:project: MedicalLib
:members:
Related Structures
------------------
.. doxygenstruct:: BloodPressure
:project: MedicalLib
:members:
.. doxygenstruct:: Blood
:project: MedicalLib
:members:
Helper Functions
----------------
.. doxygenfile:: MedicalLib/Patient.h
:project: MedicalLib
:sections: func