chore: add apidoc doc-config files - #3
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds Doxygen configuration for generating API docs for the project and ignores generated documentation artifacts.
Changes:
- Added a full
Doxyfileto configure Doxygen (project metadata, inputs, output formats, exclusions, preprocessing). - Added
apidoc/.gitignoreentries for generatedhtml/andxml/outputs.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 11 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # set to NO | ||
| # The default value is: NO. | ||
|
|
||
| HAVE_DOT = NO |
| # The default value is: YES. | ||
| # This tag requires that the tag HAVE_DOT is set to YES. | ||
|
|
||
| COLLABORATION_GRAPH = YES |
| # The default value is: YES. | ||
| # This tag requires that the tag HAVE_DOT is set to YES. | ||
|
|
||
| GROUP_GRAPHS = YES |
| # The default value is: YES. | ||
| # This tag requires that the tag HAVE_DOT is set to YES. | ||
|
|
||
| INCLUDE_GRAPH = YES |
| # The default value is: YES. | ||
| # This tag requires that the tag HAVE_DOT is set to YES. | ||
|
|
||
| INCLUDED_BY_GRAPH = YES |
| # The default value is: YES. | ||
| # This tag requires that the tag HAVE_DOT is set to YES. | ||
|
|
||
| DIRECTORY_GRAPH = YES |
| # entered, it will be relative to the location where Doxygen was started. If | ||
| # left blank the current directory will be used. | ||
|
|
||
| OUTPUT_DIRECTORY = $(OUTPUT_DIRECTORY) |
| # normally produced when WARNINGS is set to YES. | ||
| # The default value is: NO. | ||
|
|
||
| EXTRACT_ALL = YES |
| # will automatically be disabled. | ||
| # The default value is: YES. | ||
|
|
||
| WARN_IF_UNDOCUMENTED = YES |
| # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 | ||
| # This tag requires that the tag USE_MATHJAX is set to YES. | ||
|
|
||
| MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
leaves12138
left a comment
leaves12138
left a comment
There was a problem hiding this comment.
LGTM. I checked the added apidoc files against the migrated source snapshot: the content is effectively the existing Doxygen configuration with ASF headers, apidoc/.gitignore covers the generated html/ and xml/ directories, and the file formatting/newline checks look good.
Non-blocking note: until include/ is migrated, running Doxygen will warn that ../include does not exist. The config is intended to be run from the apidoc/ directory, consistent with the existing source workflow.
Purpose
This PR adds two new documentation-related files:
Doxyfile
.gitignore
Tests
API and Format
Documentation
Generative AI tooling