Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Review: feat(comment): add an AST node for the javadoc tags #1310
According to Oracle, the first sentence of a JavaDoc string is referred as short summary. For instance:
/** * This is a short summary. Now follows the long description. */ ...
It might be useful to add getters for the short summary and long description to the AST node.
referenced this pull request
May 19, 2017
Oracle says: "Write the first sentence as a short summary of the method, as Javadoc automatically places it in the method summary table (and index)." (http://www.oracle.com/technetwork/articles/java/index-137868.html)
So it looks like it's up to us defining how to handle the summary. I would suggest the following:
As far as I know it's the first sentence delimited using a "." (dot). Consequently, sentences like: "The is a short summary, i.e., ..." lead to a wrong summary, as JavaDoc creates the following summary: "The is a short summary, i."
Revapi Analysis results
Old API: fr.inria.gforge.spoon:spoon-core:jar:5.7.0-20170519.095031-107
New API: fr.inria.gforge.spoon:spoon-core:jar:5.7.0-SNAPSHOT
Detected changes: 6.