Make the API documentation easier to find#254
Merged
Algiane merged 8 commits intoMmgTools:developfrom Mar 12, 2024
Merged
Conversation
…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.
Member
|
Hi, Thanks for the proposition of adding an Regarding the location of definition of the Doxygen group for the API, do you think that it can be in the Otherwise, the Thanks by advance, |
…s no effect in Markdown and it generates a verbatim <strong> in the rendered html pages
Member
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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?