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

Be able to use @example in jsdoc #297

Open
willshulman opened this issue Dec 4, 2017 · 1 comment
Open

Be able to use @example in jsdoc #297

willshulman opened this issue Dec 4, 2017 · 1 comment
Assignees
Labels

Comments

@willshulman
Copy link
Contributor

We should be able to provide links to md files which will output at the end of the description text. If we dont see "http://..." we can just take what the doclet parsed.

@tfogo
Copy link
Contributor

tfogo commented Dec 4, 2017

I don't think outputting at the end of the description text is the best implementation. I can see us wanting to include multiple examples throughout the description. Something like this might be better:

/**
 * @description Here is a config. You can set it up like this:
 *              {@example link/to/example.md}
 *              Or like this:
 *              {@example link/to/other/example.md}
 */

This would be like the Python documentation: https://docs.python.org/3.6/library/stdtypes.html#str.split

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

No branches or pull requests

3 participants