Documentation fixes#154
Closed
ellert wants to merge 15 commits into
Closed
Conversation
Properly handle macros in comments that uses /// at the beginning of the
line, i.e.
/// Begin_Macro
/// {
/// (macro code)
/// }
/// End_Macro
The old version only handled this properly if the macro was an external
file.
Don't trigger the filter if Begin_Macro and End_Macro appear on the same
line. These are comments explaining how the markup works, not markup.
Support NamespaceImp in addition to ClassImp. This makes the images for
e.g. TMath - which is a namespace and not a class - have proper names.
This fixes most of the warnings of the following types: - warning: Found ';' while parsing initializer list - warning: Illegal member name found - warning: no matching file member found for ClassImp() - warning: documented symbol 'X' was not declared or defined
The filter could be made smarter to parse unaligned macros, but since there were only two of them I found it easier to fix those.
This is not an attempt to convert the documentation to doxygen format. It is rather an attempt to address leftovers from a partial (automated?) convertion that left some of the Begin_Html/End_Html tags behind. Tags that now show up verbatim in the generated doxygen documentation. Most of these files still requires proper doxygen conversion.
Replace broken links with working ones Remove Begin_Html/End_html tags
Closed
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.
Here are some fixes to the doxygen documentation generation.