Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the API documentation easier to find #254

Merged
merged 8 commits into from
Mar 12, 2024
Merged

Conversation

mpotse
Copy link
Contributor

@mpotse mpotse commented Mar 11, 2024

Until now users had to navigate to libmmgX.h in the doxygen documentation to find the API documentation, without any guidance. Only by looking at the examples one could guess that the documentation is there.
To make this easier I defined a Doxygen group for the API docs and added configuration to make this group appear as a fifth tab on the html pages. The page under this tab lists the three files and provides a logical place for a common introduction into the three APIs.

Question: For this proposal I put the group definition in libmmg3d.h. Would there be a more appropriate place, for example a dedicted header file under src/common or something in the root of the tree?

mpotse added 2 commits March 10, 2024 20:50
…or the three header files, and set up a doc/doxygen/DoxygenLayout.xml file to create a tab for this group; also added a few lines of description.
@Algiane Algiane added kind: enhancement enhancement to an existing feature part: documentation labels Mar 11, 2024
@Algiane
Copy link
Member

Algiane commented Mar 11, 2024

Hi,

Thanks for the proposition of adding an API tab on the documentation.

Regarding the location of definition of the Doxygen group for the API, do you think that it can be in the src/mmg/libmmg.h header file ? This header allows to directly include the headers needed for the 3 libraries.

Otherwise, the src/common/libmmgtypes.h header may be a suitable location too.

Thanks by advance,

@Algiane Algiane merged commit 62f1818 into MmgTools:develop Mar 12, 2024
23 checks passed
@Algiane
Copy link
Member

Algiane commented Mar 12, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: enhancement enhancement to an existing feature part: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants