The summary section should be brief. On a documentation web site,
it will be shown on a page that lists summaries for many different
API items. On a detail page for a single item, the summary will be
shown followed by the remarks section (if any).
Remarks
The main documentation for an API item is separated into a brief
"summary" section optionally followed by an @remarks block containing
additional details.
Bye Core Function
The summary section should be brief. On a documentation web site, it will be shown on a page that lists summaries for many different API items. On a detail page for a single item, the summary will be shown followed by the remarks section (if any).
Remarks
The main documentation for an API item is separated into a brief "summary" section optionally followed by an
@remarksblock containing additional details.Example
Here is a simple example: