Skip to content
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.

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

Include types defined w/ @typedef in docs #21

Closed
dtao opened this issue Nov 6, 2013 · 2 comments
Closed

Include types defined w/ @typedef in docs #21

dtao opened this issue Nov 6, 2013 · 2 comments

Comments

@dtao
Copy link
Owner

dtao commented Nov 6, 2013

Maybe make this an option.

@dtao
Copy link
Owner Author

dtao commented Jan 8, 2014

Done in 0.5.4 (cc: @kentcdodds)

I'm not sure if this was a good decision or not (open to reconsidering), but currently the logic is that if you have any functions and/or types with the @public tag, then Autodoc assumes the things marked @public are the only ones you want to include in documentation. So basically that means you need to tag your types w/ @public too if you want them to appear.

@dtao dtao closed this as completed Jan 8, 2014
@kentcdodds
Copy link
Contributor

I think that's a good assumption to make. There could be some internal objects that I don't want on the documentation to avoid confusion. It looks great. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants