Как две функции @apiName в одном файле класса в apiDocJs?
У меня есть сервлет, который может обрабатывать несколько путей и делать разные вещи на основе этого. Я хочу задокументировать различные функции в файле класса, используя http://apidocjs.com/ но не могу понять, как заставить их отображаться. Когда я пытаюсь это сделать (см. Ниже), появляется только первый:
/**
* @api {get} /authenticate/user?
* @apiName Authenticator
* @apiGroup Authentication
*
* @apiDescription Authenticate a user
*
* @apiSampleRequest /authenticate/user
*
* @apiParam {String} username User name
* @apiParam {String} password User password
*
* @apiSuccess {JSONObject} user User
*
* @apiExample Success-Response (example):
* {
* ...
* }
*
* @apiExample Error-Response (example):
* {
* ...
* }
*
* @api {get} /authenticate/app?
* @apiName Authenticator
* @apiGroup Authentication
*
* @apiDescription Authenticate an app
*
* @apiSampleRequest /authenticate/app
*
* @apiParam {String} appId App Id
* @apiParam {String} appKey Secret Key
*
* @apiSuccess {JSONObject} app App
*
* @apiExample Success-Response (example):
* {
* ...
* }
*
* @apiExample Error-Response (example):
* {
* ...
* }
*/
1 ответ
Решение
Просто обнаружил, что если вы разделите его на два блока комментариев, он будет работать:
/**
* @api {get} /authenticate/user?
* @apiName Authenticator
* @apiGroup Authentication
*
* @apiDescription Authenticate a user
*
* @apiSampleRequest /authenticate/user
*
* @apiParam {String} username User name
* @apiParam {String} password User password
*
* @apiSuccess {JSONObject} user User
*
* @apiExample Success-Response (example):
* {
* ...
* }
*
* @apiExample Error-Response (example):
* {
* ...
* }
*/
/**
* @api {get} /authenticate/app?
* @apiName Authenticator
* @apiGroup Authentication
*
* @apiDescription Authenticate an app
*
* @apiSampleRequest /authenticate/app
*
* @apiParam {String} appId App Id
* @apiParam {String} appKey Secret Key
*
* @apiSuccess {JSONObject} app App
*
* @apiExample Success-Response (example):
* {
* ...
* }
*
* @apiExample Error-Response (example):
* {
* ...
* }
*/