Initial support for table rendering #632
Merged
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
vermeeren
added
code
This adds basic support to table rendering. Tables generates using Markdown syntax or <table> both generate a similar Doxygen so both can be used in documentation. https://www.doxygen.nl/manual/tables.html https://www.doxygen.nl/manual/markdown.html#md_tables Some features are still missing, like colspan, rowspan and alignment. Those are not available in the Doxygen XML generated by versions <=1.8.17. Doxygen XML generated by Doxygen 1.9.1 works correctly. When using those features the current implementation will just output blank rows or cols, rendering improperly, but without exceptions. Signed-off-by: Fabio Utzig <utzig@apache.org>
|
@vermeeren I just updated the commit message; this should be good enough for an initial support. Let me know if you need some example updated or other documentation change. |
vermeeren
approved these changes
Feb 13, 2021
There was a problem hiding this comment.
@utzig Looks good, thanks again! Placing a table in the example documentation somewhere might be nice to have. I notice in the links in the commit message the upstream Doxygen documentation has a really complex example for the <table> variant.
Thoughts on including this one as-is somewhere? Seems like a complex example to track and test full table support for the long term.
Will merge this PR as-is, any doc or future work is of course fine as a different PR.
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.
This adds basic support to table rendering. Tables generates using Markdown syntax or
both generate a similar Doxygen so both can be used in documentation.https://www.doxygen.nl/manual/tables.html
https://www.doxygen.nl/manual/markdown.html#md_tables
Some features are still missing, like colspan, rowspan and alignment. Those are not available in the Doxygen XML generated by versions <=1.8.17. Doxygen XML generated by Doxygen 1.9.1 works correctly. When using those features the current implementation will just output blank rows or cols, rendering improperly, but without exceptions.
Fixes #629