Skip to content

docs: document C++ Doxygen group pages in library docs generator - #6757

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787763958-cpp-doxygen-groups
Open

docs: document C++ Doxygen group pages in library docs generator#6757
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787763958-cpp-doxygen-groups

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

C++ library authors organize their APIs with Doxygen groups (@defgroup / @ingroup / @addtogroup) in their source, but until now the library docs generator dropped that structure: readers only saw the raw namespace and symbol hierarchy. The generator now renders each group as an index page under a groups/ folder in output.path, with the group's description and links to its members and subgroups, so a library's own conceptual organization becomes browsable in the docs with no configuration beyond the annotations already in the source. Group pages link to the existing symbol pages rather than duplicating content, and empty groups are skipped.

Implements docs for: feat(cli): render Doxygen group pages for C++ library docs (fern-api/fern#17420)

Pages changed

  • fern/products/docs/pages/api-references/library-docs.mdx — new ## Doxygen groups section covering the groups/ output, nested subgroups, member links, and that empty groups are skipped and no navigation change is needed.
  • fern/products/docs/pages/changelog/2026-08-26.mdx — Docs changelog entry for the feature, tagged api-reference, linking to the new section.

Note: this touches the same page as the open, unrelated PR #6700 (Doxyfile settings); this branch is off main and the diff is confined to a new section, so it should merge cleanly.

Link to Devin session: https://app.devin.ai/sessions/62fb506b8a56492286ca546dd6ed809c

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