Automatic extraction of class/method/property summary from the first sentence of the doc comment
AdrianVasiliu opened this issue · comments
(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
An alternative to the first sentence is the first paragraph.