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 (557 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,751 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Implement parsing of '#' and '~' symbols in @memberof tag to support instance and inner members, and handle nested paths like Parent#Child.
Tech stack
javascript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60