Doxygen touch-ups #130
Merged
Doxygen touch-ups #130
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
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.
No code changes. Only in-comment changes.
Cleanup of PR #67. Modified to retain leading asterisk in
<pre>blocks. In that PR, it was reported leading asterisk affected generated html. I was unable to reproduce those issues, and the generated html appeared OK. This may be a doxygen versioning/settings issue. SeeTest Stepssection below.Description
<pre><\pre>wrappers. These wrappers were added<pre>blocks can be placed on separate lines, rather than inline. Improves doxygen code readability while retaining presentation;at the end of the doxygen function signature. The semicolons were added for consistency with other signaturesNote: Neither PR #67 nor this PR contain changes to
<PRE>tags. HTML tags are case-insensitive so it's the same as<pre>. I did not alter the uppercase<PRE>in case uppercase vs. lowercase had some non-functional purpose intended, like organization or emphasis mechanism. Will need to follow up with Richard, but we may end up opting for either all lowercase or uppercase<PRE>for consistency.Test Steps
Generate the HTML. Verify no warnings/errors regarding unclosed
<pre>blocks and that all API functions have a doxygen function signature. Visually verify changes. You can use the attached config file, or try out your own doxygen config.Tested with doxygen v1.8.17
Related Issue
PR #67
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.