LearnNewsExamplesServices
Frontmatter
id7900
titleSupport `@ignoreDocs` JSDoc tag to exclude files from Docs app structure
stateClosed
labels
documentationenhancement
assigneestobiu
createdAtNov 24, 2025, 3:03 PM
updatedAtNov 24, 2025, 3:17 PM
githubUrlhttps://github.com/neomjs/neo/issues/7900
authortobiu
commentsCount0
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtNov 24, 2025, 3:17 PM

Support @ignoreDocs JSDoc tag to exclude files from Docs app structure

Closed v11.10.0 documentationenhancement
tobiu
tobiu commented on Nov 24, 2025, 3:03 PM

Some files in the ai/ directory (like ai/mcp/server/github-workflow/services/queries/issueQueries.mjs) are valid modules but are not intended to be displayed in the public Docs app. While we have implemented filtering for ai.examples and empty folders, we need a more declarative way to exclude specific files or classes from the Docs app navigation tree.

Goal

Implement support for a custom JSDoc tag @ignoreDocs. When this tag is present in a file's top-level comment block, jsdocx.mjs should skip generating a structure entry for it.

Implementation Details

  1. Update buildScripts/docs/jsdocx.mjs:

    • In the parsing loop, check if the docs object (the JSDoc output for a file) contains the @ignoreDocs tag.
    • If the tag is found, skip adding the item to the neoStructure array (or filtering it out).
    • Ensure this check happens before or during the structure generation phase.
  2. Usage:

    • Add * @ignoreDocs to the top-level JSDoc comment of ai/mcp/server/github-workflow/services/queries/issueQueries.mjs and potentially other query modules.

Verification

  • Add the tag to issueQueries.mjs.
  • Run npm run generate-docs-json.
  • Verify issueQueries is no longer in docs/output/structure.json.
tobiu added the documentation label on Nov 24, 2025, 3:03 PM
tobiu added the enhancement label on Nov 24, 2025, 3:03 PM
tobiu assigned to @tobiu on Nov 24, 2025, 3:04 PM
tobiu referenced in commit 219d620 - "Support @ignoreDocs JSDoc tag to exclude files from Docs app structure #7900" on Nov 24, 2025, 3:17 PM
tobiu closed this issue on Nov 24, 2025, 3:17 PM