docs(library-docs): document supported Doxyfile settings and Doxygen group pages - #6700
Merged
Conversation
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: |
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
Bot
force-pushed
the
devin/1787245687-doxyfile-allowlist
branch
from
September 9, 2026 17:30
345de45 to
19aec56
Compare
devin-ai-integration
Bot
requested review from
jkonrath-postman and
nerminamiller-postman
as code owners
September 9, 2026 17:30
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>
Ryan-Amirthan
approved these changes
Sep 9, 2026
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
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
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_Cinto its own doxygen configuration and ignores everything else. Settings that used to work (notablyINPUTand@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/@addtogroupas index pages undergroups/inoutput.path.Pages changed
fern/products/docs/pages/api-references/library-docs.mdxconfig.doxyfilein the configuration reference 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 (spaces/shell metacharacters inFILE_PATTERNS, non-YES/NObooleans, malformed alias definitions, trailing backslashes,$(VAR)expansion) plus the 262,144-character limit.input.pathdirectory or repo root forgit); Doxyfile input directives have no effect.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