Skip to content

docs(library-docs): document supported Doxyfile settings - #6700

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787245687-doxyfile-allowlist
Open

docs(library-docs): document supported Doxyfile settings#6700
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787245687-doxyfile-allowlist

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

For C++ library docs, Fern no longer hands a customer's Doxyfile to doxygen as-is. It now reads only four settings from it (ALIASES, PREDEFINED, FILE_PATTERNS, OPTIMIZE_OUTPUT_FOR_C) into its own doxygen configuration and ignores everything else. That makes doxygen configuration predictable and safe, but it also means settings that used to work — notably INPUT and @INCLUDE — are now silently dropped, and invalid values for the four supported settings fail the docs publish. Authors configuring config.doxyfile need the supported surface spelled out, and the page's existing claim that Doxyfile input directives widen the source root is now wrong.

Implements docs for: fix(fdr): sanitize user-provided doxyfile settings through an allowlist (fern-api/fern-platform#14062)

Pages changed

  • fern/products/docs/pages/api-references/library-docs.mdx
    • config.doxyfile in the configuration reference now 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 enough to fail publishing (spaces/shell metacharacters in FILE_PATTERNS, non-YES/NO booleans, malformed alias definitions, trailing backslashes, $(VAR) expansion) plus the 262,144-character content limit.
    • Corrected the C++ source-root note, which said the effective scope was path combined with the Doxyfile's input entries. The parser uses the input.path directory as the source root; Doxyfile input directives have no effect.
  • fern/products/docs/pages/changelog/2026-08-20.mdx — new entry for the behavior change, since previously-honored settings stop taking effect.

Link to Devin session: https://app.devin.ai/sessions/67938d5b35e7404a93790995cf9f21b8

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@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

Copy link
Copy Markdown
Contributor

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.

0 participants