documentationjs/documentation

support @memberof with namepaths including instance and inner members

Open

#189 opened on Oct 16, 2015

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (5,751 stars) (557 forks)batch import
enhancementhelp wanted

Description

Examples:

  • @memberof Parent# (equivalent to @memberof Parent, @instance)
  • @memberof Parent~ (equivalent to @memberof Parent, @inner)
  • Nested paths such as @memberof Parent#Child

Contributor guide

Tech stack
javascript
Domain
documentationtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JSDoc namepathsdocumentationjs codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the current parsing logic for @memberof in the codebase (likely in lib/parse.js). Determine how to extend it to support trailing # and ~ symbols and nested paths. Check if there are existing tests for @memberof. Consider adding corresponding test cases. Look at the JSDoc specification for namepaths to ensure correctness.