Enable EXTRACT_ALL in Doxyfile to display documentation #873
Conversation
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
…oxygen Signed-off-by: Thijs Raymakers <[email protected]>
Contributor
|
I guess the question is why EXTRACT_ALL was removed in the first place, since it seems deliberate. @ahcorde @Blast545 (maybe @chapulina) can you comment? |
Contributor
|
After looking at this, I don't think this is the way we want to go. Instead we want to do something more like #896, where we explicitly enable documentation of the files as necessary. Because of that, I'm going to close this out. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Currently, the documentation on https://docs.ros2.org/latest/api/rcl/index.html does not display anything besides the contents of the header file. This change was introduced in #712. This makes it difficult to use the documentation at all, because all information regarding how a function should be used is not displayed.
This change enables the previously removed EXTRACT_ALL to restore the documentation to its intended state.