Doxygen fixes#908
Open
tbleher wants to merge 4 commits into
Open
Conversation
Signed-off-by: Thomas Bleher <thomas.tb.bleher@bmw.de>
Signed-off-by: Thomas Bleher <thomas.tb.bleher@bmw.de>
If \brief is not set, Doxygen will generate a brief description from the first sentence. The sentence stops whenever Doxygen encounters a ". " sequence. This led to strangely cut off sentences in the generated Doxygen documentation. Fix this by escaping the whitespace following a dot in a sentence that should be continued. Signed-off-by: Thomas Bleher <thomas.tb.bleher@bmw.de>
Doxygen complained about this. Signed-off-by: Thomas Bleher <thomas.tb.bleher@bmw.de>
Contributor
Author
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
1 participant
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.
This fixes a bunch of spelling and Doxygen errors. No functional changes - just making sure the documentation is easier to read.