-
-
Notifications
You must be signed in to change notification settings - Fork 201
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add initial xrefsect support #589
Conversation
Add basic parsing support and rendering of xrefsect blocks. The current implementation does not generate links or any pages. An xrefsect is generated when a @xrefitem keyword is found in Doxygen documentation, as well as the specialized forms like @bug, @test and @deprecated. https://www.doxygen.nl/manual/commands.html#cmdxrefitem Signed-off-by: Fabio Utzig <[email protected]>
For an example, this source:
Will render like this: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@utzig Diff itself is good, but could you add the documentation example to the doc? I'm thinking somewhere on documentation/source/specific.rst
is good. Probably with a title like Doxygen xrefsect
. Thanks!
Add new section with xrefsect examples to specific page; add a \todo, \test, \deprecated and \bug Doxygen special commands and create a custom aliased xrefitem. Signed-off-by: Fabio Utzig <[email protected]>
Done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@utzig Thanks, much appreciated!
@utzig Released as v4.23.0. |
Add basic parsing support and rendering of xrefsect blocks. The current implementation does not generate links or any pages.
An xrefsect is generated when a @xrefitem keyword is found in Doxygen documentation, as well as the specialized forms like
\bug
,\test
and\deprecated
.https://www.doxygen.nl/manual/commands.html#cmdxrefitem