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

时间:2014-07-22 14:48来源: 作者: 点击: 次

分享到：

支持ci所有版本php版本=5.0项目地址：https://github.com/ym1623/codeigniter_apidoc/文档地址：http://ym1623.github.io/codeigniter_apidoc/论坛帖子：http://codeigniter.org.cn/forums/forum.php?mod=viewthreadextra=page%3D1%26f

支持ci所有版本
php版本>=5.0
项目地址：https://github.com/ym1623/codeigniter_apidoc/
文档地址：http://ym1623.github.io/codeigniter_apidoc/

论坛帖子：http://codeigniter.org.cn/forums/forum.php?mod=viewthread&tid=18822&extra=page%3D1%26filter%3Dtypeid%26typeid%3D59

/**
 * @author ym
 * @group(name="docgroup", description="文档模块")
 */
class Doc extends CI_Controller {
 
    function __construct() {
        parent::__construct();
        $this->load->library('phpdoc/apidoc');
    }
 
    /**
     * @ApiDescription(section="User", method="get", description="Get information about user")
     * @ApiNotice(description="登录后，客户端要保存服务器种下的cookie来维护session")
     * @ApiSuccess(value="{'firstname' : 'ym', 'lastname'  : '1623', 'lastLogin' : '2014-04-21'}")
     * @ApiExample(value="{'username' : 'ym', 'password'  : '123456'}")
     * @ApiAccess(login="true")
     * @ApiParams(name="id", type="integer", is_selected=true, description="User id")
     * @ApiParams(name="sort", type="enum[asc,desc]", description="User data")
     * @ApiReturn(name="id", type="integer", description="User id")
     * @ApiReturn(name="sort", type="enum[asc,desc]", description="sort data")
     * @ApiReturn(name="page", type="integer", description="data of page")
     * @ApiReturn(name="count", type="integer", description="data of page")
     */
    function build(){
        $this->apidoc->build_doc();
    }
 
}