google-labs-jules[bot]
86488cec48
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.
36 lines
547 B
ReStructuredText
36 lines
547 B
ReStructuredText
API Reference
|
|
=============
|
|
|
|
This section provides a detailed, auto-generated reference for every class, struct, and function in the MedicalLib library.
|
|
|
|
.. toctree::
|
|
:caption: Core
|
|
:maxdepth: 1
|
|
|
|
api/patient
|
|
api/organ
|
|
|
|
.. toctree::
|
|
:caption: Organs
|
|
:maxdepth: 1
|
|
|
|
api/heart
|
|
api/lungs
|
|
api/brain
|
|
api/liver
|
|
api/kidneys
|
|
api/stomach
|
|
api/intestines
|
|
api/pancreas
|
|
api/spleen
|
|
api/gallbladder
|
|
api/bladder
|
|
api/esophagus
|
|
api/spinalcord
|
|
|
|
.. toctree::
|
|
:caption: General
|
|
:maxdepth: 1
|
|
|
|
api/general
|