adobe / adobe/hyde

Add @hyde-ignore directive

Open
#93 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
340
Forks
45
PR merge metrics
No merged PRs in 30d

Description

We need a command that can be used in-source that tells hyde to ignore whatever AST node the clang driver has found. This would likely be recursive (e.g., ignore a class and the member fields and variables would be ignored, too.)

Contributor guide

Open the contributing guide

Research direction

Start by tracing how hyde receives AST nodes from the clang driver and how in-source directives are currently represented, if supported. Define the recursive behavior for ignored nodes, then verify that ignored nodes and their members or variables are excluded from generated documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.