Document C/C++ macro pages, include-undocumented-macros, and plain-C index pages in library docs - #7220
Open
fern-api[bot] wants to merge 3 commits into
Open
Document C/C++ macro pages, include-undocumented-macros, and plain-C index pages in library docs#7220fern-api[bot] wants to merge 3 commits into
include-undocumented-macros, and plain-C index pages in library docs#7220fern-api[bot] wants to merge 3 commits into
Conversation
fern-api
Bot
requested review from
jkonrath-postman and
nerminamiller-postman
as code owners
October 1, 2026 20:30
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-10-01-fern-ai-1fb7a4-b6d3e9c3.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
…lain-C and group cross-links Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
includeUndocumentedMacros for C++ libra…include-undocumented-macros, and plain-C index pages in library docs
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
The library docs generator now renders C/C++ preprocessor macros (
#define) as reference pages, so macro-heavy C and C++ SDKs get complete API reference instead of silently dropping macros. By default only macros with a Doxygen doc comment get pages, and a newinclude-undocumented-macrosoption emits every macro. Plain C libraries (symbols at global scope, no namespace) now get library and category index pages, and\ref/@seereferences inside Doxygen groups render as working links.Implements docs for: feat(cli): C/C++ library docs — macro pages, plain-C index pages, group-scoped cross-links (fern-api/fern#17789), feat(fdr): C/C++ library docs — macro extraction, function-pointer typedefs, post-deploy test (fern-api/fern-platform#14951)
Changes to
fern/products/docs/pages/api-references/library-docs.mdxdocs.ymlexamples showinclude-undocumented-macros: true # optional, C++ onlyunderconfig.\ref/@seereferences inside groups link to symbol pages, plus a new paragraph on macro pages (Macros category, group pages, documented-only default, include guards skipped) and plain-C index pages.config.include-undocumented-macrosParamField(boolean, defaultfalse, C++ only). The YAML key is kebab-case, matching theLibraryConfigschema in fern#17789.The intro paragraph is unchanged from
main.Link to Devin session: https://app.devin.ai/sessions/f58dda5bf6eb40d8bad5ee9284244ce9
Open in Devin Desktop: https://app.devin.ai/desktop/session/f58dda5bf6eb40d8bad5ee9284244ce9?variant=devin