php通过注释自动生成文档插件

01

/**

02

*
@author ym

03

*
@group(name="docgroup", description="文档模块")

04

*/

05

class

Doc 

extends

CI_Controller
{

06

07

function

__construct()
{

08

parent::__construct();

09

$this

->load->library(

'phpdoc/apidoc'

);

10

}

11

12

/**

13

*
@ApiDescription(section="User", method="get", description="Get information about user")

14

*
@ApiNotice(description="登录后，客户端要保存服务器种下的cookie来维护session")

15

*
@ApiSuccess(value="{'firstname' : 'ym', 'lastname'  : '1623', 'lastLogin' : '2014-04-21'}")

16

*
@ApiExample(value="{'username' : 'ym', 'password'  : '123456'}")

17

*
@ApiAccess(login="true")

18

*
@ApiParams(name="id", type="integer", is_selected=true, description="User id")

19

*
@ApiParams(name="sort", type="enum[asc,desc]", description="User data")

20

*
@ApiReturn(name="id", type="integer", description="User id")

21

*
@ApiReturn(name="sort", type="enum[asc,desc]", description="sort data")

22

*
@ApiReturn(name="page", type="integer", description="data of page")

23

*
@ApiReturn(name="count", type="integer", description="data of page")

24

*/

25

function

build(){

26

$this

->apidoc->build_doc();

27

}

28

29

}