Skip to content
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

Check for Doxygen warnings in CI (BSP-429) #267

Open
igrr opened this issue Jan 3, 2024 · 0 comments
Open

Check for Doxygen warnings in CI (BSP-429) #267

igrr opened this issue Jan 3, 2024 · 0 comments
Labels
Type: CI CI related taks Type: Documentation Improvements or additions to documentation Type: Feature Request New feature or request

Comments

@igrr
Copy link
Member

igrr commented Jan 3, 2024

While looking at #266 I've noticed that although we do run Doxygen in CI, we don't actually fail the CI job when new warnings (e.g. function not documented) are introduced. Looking at the job log, there are already a lot of warnings, most of them about mismatch between the parameter names in the function declaration and in the Doxygen comment.

We should either

  • change Doxygen configuration to fail on these warnings, e.g.
    WARN_AS_ERROR = YES
    
  • or, check for the presence of "warning: " string in Doxygen logs, like esp-docs does this (with an optional ignore-list)
@igrr igrr added Type: Documentation Improvements or additions to documentation Type: Feature Request New feature or request labels Jan 3, 2024
@github-actions github-actions bot changed the title Check for Doxygen warnings in CI Check for Doxygen warnings in CI (BSP-429) Jan 3, 2024
@VojtechBartoska VojtechBartoska added the Type: CI CI related taks label Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: CI CI related taks Type: Documentation Improvements or additions to documentation Type: Feature Request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants