Skip to content

Fix Doxygen parameter docs #1514

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

gemenerik
Copy link
Member

Add minimal INCLUDE_PATH entries to enable Doxygen preprocessor to find configuration headers needed for conditional LOG compilation.

Changes:

  • Add build/include/generated to INCLUDE_PATH (autoconf.h access)
  • Add src/deck/drivers/interface to INCLUDE_PATH (header definitions)

This preserves both parameter documentation and enables configuration-dependent entries (e.g. anchor 4-7 LOG entries (distance4-distance7))

Maintenance concern: Future config-dependent features in other directories may require additional INCLUDE_PATH entries, as Doxygen needs access to both config defines and the headers using them for conditional compilation.

Fixes: parameter documentation broken in commits 6e313ca through ee1db76

…tion

Add minimal INCLUDE_PATH entries to enable Doxygen preprocessor to find
configuration headers needed for conditional LOG compilation.

Changes:
- Add build/include/generated to INCLUDE_PATH (autoconf.h access)
- Add src/deck/drivers/interface to INCLUDE_PATH (header definitions)

This preserves both parameter documentation and enables
configuration-dependent entries (e.g. anchor 4-7 LOG entries (distance4-distance7))

Maintenance concern: Future config-dependent features in other directories
may require additional INCLUDE_PATH entries, as Doxygen needs access to
both config defines and the headers using them for conditional compilation.

Fixes: parameter documentation broken in commits 6e313ca through ee1db76
@gemenerik gemenerik linked an issue Aug 6, 2025 that may be closed by this pull request
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.

Autodoc for params is broken
1 participant