Skip to content

Fix header parsing of documentation generator#715

Open
thellef wants to merge 1 commit intodevelopfrom
feature/docgen-fixes
Open

Fix header parsing of documentation generator#715
thellef wants to merge 1 commit intodevelopfrom
feature/docgen-fixes

Conversation

@thellef
Copy link
Contributor

@thellef thellef commented Jan 21, 2026

  • Parse the headers in a predictable order by sorting
  • Add a 'generictag' regex so any tag, even unknown, will stop the parsing of text to current tag, e.g. @param
  • Modify regex for 'method' so it also accepts a function declaration where we return Core::ERROR_UNSUPPORTED (or do other things).
  • gitignore pycache to avoid accidentally adding those
  • Change @parm -> @param in IXCast.h

And updated all MD documentation files with the updated generator.

version:patch

* Parse the headers in a predictable order by sorting
* Add a 'generictag' regex so any tag, even unknown, will stop the
parsing of text to current tag, e.g. @param
* Modify regex for 'method' so it also accepts a function declaration
where we return Core::ERROR_UNSUPPORTED (or do other things).
* gitignore __pycache__ to avoid accidentally adding those
* Change @parm -> @param in IXCast.h

And updated all MD documentation files with the updated generator.

version:patch
@thellef thellef self-assigned this Jan 21, 2026
@thellef thellef requested a review from a team as a code owner January 21, 2026 10:17
Copilot AI review requested due to automatic review settings January 21, 2026 10:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the header parsing functionality of the documentation generator with several key enhancements. The changes ensure more predictable and reliable documentation generation.

Changes:

  • Enhanced the header parser to handle unknown doxygen tags and function declarations with implementations
  • Fixed ordering issues by sorting header files before processing
  • Corrected a typo (@parm@param) in IXCast.h
  • Added Python bytecode directory to .gitignore
  • Regenerated all markdown documentation files with the improved parser

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tools/md_generator/h2md/header_file_parser.py Added 'generictag' regex to handle unknown tags; improved 'method' regex to match functions with inline implementations
tools/md_generator/h2md/generate_md_from_header.py Sorted header files to ensure predictable processing order
apis/XCast/IXCast.h Fixed spelling typo: @parm@param
.gitignore Added pycache to prevent committing Python bytecode
docs/apis/*.md Regenerated documentation files reflecting the parser improvements (ordering changes, cleaned descriptions)
docs/_sidebar.md Added FirmwareDownload entry

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants