docs(library-docs): document supported Doxyfile settings - #6700
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs(library-docs): document supported Doxyfile settings#6700devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1787245687-doxyfile-allowlist.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 — notablyINPUTand@INCLUDE— are now silently dropped, and invalid values for the four supported settings fail the docs publish. Authors configuringconfig.doxyfileneed 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.mdxconfig.doxyfilein the configuration reference now lists the four honored settings, states that everything else (includingINPUT,INPUT_FILTER,GENERATE_XML,@INCLUDE,@INCLUDE_PATH) is ignored, and describes what makes a value invalid enough to fail publishing (spaces/shell metacharacters inFILE_PATTERNS, non-YES/NObooleans, malformed alias definitions, trailing backslashes,$(VAR)expansion) plus the 262,144-character content limit.pathcombined with the Doxyfile's input entries. The parser uses theinput.pathdirectory 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