如何在 apiDocJs 的一个 class 文件中包含两个 @apiName 函数?
How have two @apiName functions in one class file in apiDocJs?
我有一个 servlet,可以处理多个路径并基于它做不同的事情。我想使用 http://apidocjs.com 记录 class 文件中的不同函数,但不知道如何让两个函数显示出来。当我尝试这个(见下文)时,只有第一个出现:
/**
* @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):
* {
* ...
* }
*/
刚刚发现如果将它分成两个评论块,它会起作用:
/**
* @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):
* {
* ...
* }
*/
我有一个 servlet,可以处理多个路径并基于它做不同的事情。我想使用 http://apidocjs.com 记录 class 文件中的不同函数,但不知道如何让两个函数显示出来。当我尝试这个(见下文)时,只有第一个出现:
/**
* @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):
* {
* ...
* }
*/
刚刚发现如果将它分成两个评论块,它会起作用:
/**
* @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):
* {
* ...
* }
*/