neo4j / neo4j/neo4j-javascript-driver
Add protected method docs to generated documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 917
- Forks
- 158
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 7
Description
Summary
Can esdoc please be made to also output docs for the protected methods (like the constructor on the Driver class)?
Steps to reproduce
- Look at Neo4j javascript lib docs
- Look for Driver class
Expected behavior
I expect to see the docs for the constructor.
Actual behavior
There are no docs for the constructor, presumably because it is a protected method.
Other info
FWIW, it would also be nice to get docs for the types like the MetaInfo and DriverConfig.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how ESDoc generates documentation for the Neo4j JavaScript driver, then inspect the Driver class and its constructor output. Compare the generated docs with the MetaInfo and DriverConfig types mentioned in the issue; done means protected methods and the requested types appear in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100