Skip to content

docs(library-docs): document supported Doxyfile settings and Doxygen group pages - #6700

Merged
devalog merged 6 commits into
mainfrom
devin/1787245687-doxyfile-allowlist
Sep 9, 2026
Merged

docs(library-docs): document supported Doxyfile settings and Doxygen group pages#6700
devalog merged 6 commits into
mainfrom
devin/1787245687-doxyfile-allowlist

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Two C++ library-docs behavior changes, consolidated into one PR (absorbs #6757):

Doxyfile allowlist (fern-api/fern-platform#14062): Fern no longer hands a customer's Doxyfile to doxygen as-is. It reads only ALIASES, PREDEFINED, FILE_PATTERNS, OPTIMIZE_OUTPUT_FOR_C into its own doxygen configuration and ignores everything else. Settings that used to work (notably INPUT and @INCLUDE) are silently dropped, and invalid values for the four supported settings fail the publish. The page's existing claim that Doxyfile input directives widen the source root was wrong and is corrected.

Doxygen groups (fern-api/fern#17420): the generator now renders @defgroup / @ingroup / @addtogroup as index pages under groups/ in output.path.

Pages changed

  • fern/products/docs/pages/api-references/library-docs.mdx
    • config.doxyfile in the configuration reference lists the four honored settings, states that everything else (including INPUT, INPUT_FILTER, GENERATE_XML, @INCLUDE, @INCLUDE_PATH) is ignored, and describes what makes a value invalid (spaces/shell metacharacters in FILE_PATTERNS, non-YES/NO booleans, malformed alias definitions, trailing backslashes, $(VAR) expansion) plus the 262,144-character limit.
    • Corrected the C++ source-root note (rebased over docs: --local supports git library inputs #6736's git-input wording): the parser uses the source root (input.path directory or repo root for git); Doxyfile input directives have no effect.
    • Doxygen group output is described in the "Generate" step alongside the existing sentence on what the generated docs contain.

No changelog entries (removed per review).

Link to Devin session: https://app.devin.ai/sessions/db14f54a90df4591bdb133f8cd657148
Open in Devin Desktop: https://app.devin.ai/desktop/session/db14f54a90df4591bdb133f8cd657148?variant=devin

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration
devin-ai-integration Bot force-pushed the devin/1787245687-doxyfile-allowlist branch from 345de45 to 19aec56 Compare September 9, 2026 17:30
@devin-ai-integration devin-ai-integration Bot changed the title docs(library-docs): document supported Doxyfile settings docs(library-docs): document supported Doxyfile settings and Doxygen group pages Sep 9, 2026
devalog and others added 3 commits September 9, 2026 17:36
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devalog
devalog merged commit 327b80b into main Sep 9, 2026
4 checks passed
@devalog
devalog deleted the devin/1787245687-doxyfile-allowlist branch September 9, 2026 18:19
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.

2 participants