2016-06-20 3 views
0

여러 개의 경로를 처리 할 수있는 서블릿이 있는데 그 중 하나를 기반으로 다른 작업을 수행합니다. http://apidocjs.com을 사용하여 클래스 파일의 여러 함수를 문서화하려고하지만 두 개를 표시하는 방법을 알아낼 수 없습니다. 나는이 때 첫 번째 하나가 표시됩니다 (아래 참조) : 두 개의 주석 블록으로 분할하는 경우apiDocJs의 한 클래스 파일에 두 개의 @apiName 함수가있는 방법은 무엇입니까?

/** 
* @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): 
*  { 
*   ... 
*  } 
*/