@summary Summary Provides a summary for the documentation page. Syntax @summary text Parameters text The summary text. Description The @summary tag is used for providing a summary for the documentation page or item being documented. Summaries are useful, especially when the detailed description can be several pages in length. Summaries can be used for generating tables of contents, autocomplete (code completion) hints, and so on. Examples Documenting an 'add' Method 12345678910111213class Calculator{ /** * Adds two numbers together and returns the result. (This is the detailed * description. Typically, this text may be much longer.) * * @summary Adds two numbers together. */ int add(int x, int y) { return x + y; }} Share HTML | BBCode | Direct Link