Problem
Class variables (for example @@rubber_ducks) are currently missing from generated markdown and index.csv in rdoc-markdown, while previous YARD-based output indexed them.
Desired outcome:
- class variables are discoverable in generated docs,
- class variables are represented in
index.csv.
Constraints and Investigation Notes
- RDoc parser does not expose class variables in the same way as constants.
- In Ruby parser logic, constant capture is gated by
/^\\w+$/, which excludes @@... names.
- This likely requires either:
- using hidden/available parser metadata if present, or
- a supplemental extraction pass (Prism/Ripper-based) mapped to class/module context.
Proposed Tasks
Example Expected Entry
Duck.@@rubber_ducks,Constant,Duck.md#classvariable--40-40rubber_ducks
Acceptance Criteria
- Class variables appear in markdown with valid anchors.
- Class variables appear in
index.csv.
- Index links resolve to real anchors.
- Existing tests continue to pass.
Problem
Class variables (for example
@@rubber_ducks) are currently missing from generated markdown andindex.csvinrdoc-markdown, while previous YARD-based output indexed them.Desired outcome:
index.csv.Constraints and Investigation Notes
/^\\w+$/, which excludes@@...names.Proposed Tasks
index.csvrows (proposedtype=Constantfor compatibility with existing consumers).Example Expected Entry
Duck.@@rubber_ducks,Constant,Duck.md#classvariable--40-40rubber_ducksAcceptance Criteria
index.csv.