@apiSuccessTitle

Usage: @apiSuccessTitle (MyGroup) This are the Parameters for MyGroup:

Name

Description

(group)

All success messages will be grouped by this name.

description

In documentation the short group-name will be replaced with the description.

Examples:

/**
* @api {post} /user/
* @apiSuccessTitle (All) 200 - Data for all users:
* @apiSuccess (All) id The ID of a user.
* @apiSuccess (All) name The name of a user.
*
* @apiSuccessTitle (LoggedIn) Data for LoggedIn users:
* @apiSuccess (LoggedIn) id The ID of a user.
* @apiSuccess (LoggedIn) name The name of a user.
* @apiSuccess (LoggedIn) email E-Mail address of a user.
*/
Example without @apiErrorTitle:
/**
* @api {post} /user/
* @apiSuccess (200 - Data for all users:) id The ID of a user.
* @apiSuccess (200 - Data for all users:) name The name of a user.
*
* @apiSuccess (Data for LoggedIn users:) id The ID of a user.
* @apiSuccess (Data for LoggedIn users:) name The name of a user.
* @apiSuccess (Data for LoggedIn users:) email E-Mail address of a user.
*/