Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Document all exported bindings and public methods #433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
arv opened this issue May 24, 2016 · 1 comment
Closed

Document all exported bindings and public methods #433

arv opened this issue May 24, 2016 · 1 comment

Comments

@arv
Copy link
Contributor

arv commented May 24, 2016

Right now it seems like I need to add a JSDoc comment for the function/var/method to be documented.

/** Included */
export function f() {}

export function g() {}

I would like to have g be part of my API docs even when there is no JSDoc for it.

Similarly for methods:

class C {
  /** included */
  m() {}
  n() {}
  _o() {}
}

Similarly I would like m and n to be listed as methods of C

Is there an option to do this?
@tmcw
Copy link
Member

tmcw commented May 24, 2016

Hey Erik!

Going to close this ticket in favor of the very similar one posted by Cameron a few days ago: #424

As it stands, documentation.js does require some handwritten documentation in order for things to be included. I think this is the right default, given that it reflects the behavior of other documentation generators and an on-by-default behavior would introduce the potential pitfall of how to not document a specific thing that shouldn't be included.

@tmcw tmcw closed this as completed May 24, 2016
rhendric pushed a commit to rhendric/documentation that referenced this issue Sep 15, 2022
@sigma-andex
Update documentation reflecting removal of async exists (documentatio…
9eab6bc 
…njs#433)

* Update documentation reflecting removal of async exists

* Add node-fs-aff breaking changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tmcw @arv