Enhancing KhalimskySpace related class documentations. #1398
Conversation
This file contains 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
Starting documentation with @brief so that a brief description is dispayed in the class member list, thus allowing the user to know its purpose without having to click on the link.
Conflicts: ChangeLog.md
|
thanks ! |
|
All good for me.. merging |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Description
Since b5f1d12, the brief description of class members is displayed in the member list (without having to click on the member). A brief description is defined when preceded by
@briefor when using single line documentation (beginning with///or///<). TheJAVADOC_AUTOBRIEFoption can allow to consider the first lines as the brief description but it is not adapted to how documentation is written in DGtal.This PR adapts the documentation of KhalimskySpace and related classes so that to have a brief description for each member.
Checklist
cmakemode (otherwise, Travis C.I. will fail).