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

Automatic extraction of class/method/property summary from the first sentence of the doc comment #13

Open
AdrianVasiliu opened this issue Apr 3, 2014 · 1 comment

Comments

@AdrianVasiliu
Copy link

(minor)
It might be nice to have a feature similar to Javadoc's feature to automatically extract the summary documentation from the first sentence of the JDoc comment. This would avoid the need of explicit @summary and @description tags.

See “Plugin to automatically extract a summary, if missing, from the first sentence in the description”: jsdoc/jsdoc#485

@wkeese
Copy link
Member

wkeese commented May 28, 2014

An alternative to the first sentence is the first paragraph.

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

3 participants