Fix empty navigation tree in doxygen documentation output#1349
Merged
AniruddhaKanhere merged 1 commit intoJun 18, 2026
Merged
Conversation
The custom docs/doxygen/layout.xml (authored for doxygen 1.8.20) wraps a visible <filelist> tab inside a <tab type="files" visible="no"> parent. In doxygen 1.9.x and later, an invisible parent tab hides its entire subtree, so the file list never renders. Since classes/structs and globals are hidden by design, the file list is the only navigable content, leaving the published docs at https://freertos.github.io/FreeRTOS-Plus-TCP/ with an effectively empty navigation tree and unreachable API documentation. Set the parent 'files' tab to visible="yes" so the file list renders again. Globals and internal data structures remain hidden, preserving the original layout intent.
patrzhan
approved these changes
Jun 18, 2026
rawalexe
approved these changes
Jun 18, 2026
gmtt
approved these changes
Jun 18, 2026
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.
Description
The published API documentation at https://freertos.github.io/FreeRTOS-Plus-TCP/ renders pages but has an empty navigation tree — none of the documented files, types, or functions are reachable from the UI. The generated
navtreedata.jscontains only the (empty) main page:Root cause
docs/doxygen/layout.xmlwas authored for doxygen 1.8.20, where wrapping a visible<filelist>tab inside a<tab type="files" visible="no">parent was the idiom to show a single flat "Files" entry. In doxygen 1.9.x and later, an invisible parent tab hides its entire subtree, so the file list never renders. Because classes/structs and globals are intentionally hidden in this layout, the file list is the only navigable content — hiding it leaves the navigation effectively empty.Fix
Set the parent
filestab tovisible="yes". The file list renders again; globals and internal data structures remain hidden, preserving the original layout intent.Test Steps
config.doxyfile(doxygen 1.16.1) — matches the live site.doxygen docs/doxygen/config.doxyfile, exit 0, no new warnings) produces a populated navtree (Files→ all 42 documented source files), and API functions such asFreeRTOS_socketare reachable.Note
Already-deployed per-version sites on the
gh-pagesbranch will remain broken until regenerated and redeployed; this change fixes future doxygen builds.