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.
29 lines
421 B
ReStructuredText
29 lines
421 B
ReStructuredText
Heart
|
|
=====
|
|
|
|
.. doxygenclass:: Heart
|
|
:project: MedicalLib
|
|
:members:
|
|
:protected-members:
|
|
:undoc-members:
|
|
|
|
Related Structures
|
|
------------------
|
|
|
|
.. doxygenstruct:: Valve
|
|
:project: MedicalLib
|
|
:members:
|
|
|
|
.. doxygenstruct:: Chamber
|
|
:project: MedicalLib
|
|
:members:
|
|
|
|
Related Enums
|
|
-------------
|
|
|
|
.. doxygenenum:: ValveStatus
|
|
:project: MedicalLib
|
|
|
|
.. doxygenenum:: ChamberState
|
|
:project: MedicalLib
|