raspberrypi
Doxygen: Curate which headings appear in the TOC
From Graham:
Always bugged me about the default Doxygen, but move the Detailed Description to the top… perhaps we want “Description”, “Members” or “Index” basically the list of data structures, typedefs functions etc - they can keep their headings… I don’t think having a section for the individual “Function Documentation” helps on the left, you are either going to search, or click from the “members"
Preliminary thoughts: most of the headings are based directly on what's coming from doxygen. In order to remove certain headings from the TOC, we need some predictable rules about which headings should be removed. This can be as simple as an exact string match, or more complex (e.g., headings that are tagged with a certain class in doxygen), but whatever the rule is, it needs to be fixed and consistent.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
Does the latest marged PR to restore the SDK docs to the PDF documentation have any knock on here?
Re how the doxygentoasciidoc library for the Raspberry Pi Pico C/C++ SDK book does this:
We parse the raw Doxygen XML output into a tree of Node objects and then compile that to AsciiDoc by implementing a to_asciidoc method on each type of Node.
By default, Nodes will try to convert each of their children in order (meaning elements will appear in the order they appear in the original XML) but we also override that default implementation for most Nodes in order to control their appearance in the resulting PDF, e.g. a GroupNode specifically pulls its briefdescription and detaileddescription up to the top even though they really appear quite far down in the source XML.
I'm not sure how applicable that is to the current HTML version included in the documentation site as I believe that is transformed from Doxygen's own HTML output which may lack the amount of detail present in the XML (e.g. descriptions may be output as <p> tags without retaining whether they were originally a briefdescription or a detaileddescription)?
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.