PHPackages                             vegas-cmf/apidoc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. vegas-cmf/apidoc

AbandonedArchivedLibrary[API Development](/categories/api)

vegas-cmf/apidoc
================

Vegas CMF API Documentor

v1.1.0(11y ago)1642MITPHPPHP >=5.4

Since Dec 2Pushed 11y ago5 watchersCompare

[ Source](https://github.com/vegas-cmf/apidoc)[ Packagist](https://packagist.org/packages/vegas-cmf/apidoc)[ RSS](/packages/vegas-cmf-apidoc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (5)Versions (6)Used By (0)

Vegas CMF API Documentor
========================

[](#vegas-cmf-api-documentor)

[![Build Status](https://camo.githubusercontent.com/85f2048e3c376a5143d29b049b4cc91f0b2d96cb09cbce633f2dfa4c6747a0c1/68747470733a2f2f7472617669732d63692e6f72672f76656761732d636d662f617069646f632e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/vegas-cmf/apidoc)[![Coverage Status](https://camo.githubusercontent.com/d11912f1822afd53b8f4c821c870927f0e9f311867e33b610e1e8194ae940fb3/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f76656761732d636d662f617069646f632f62616467652e706e673f6272616e63683d6d6173746572)](https://coveralls.io/r/vegas-cmf/apidoc?branch=master)[![Latest Stable Version](https://camo.githubusercontent.com/c75f14166d3801a772ac688b41af8f214cb802a247dab29bceded8e86b20634d/68747470733a2f2f706f7365722e707567782e6f72672f76656761732d636d662f617069646f632f762f737461626c652e706e67)](https://packagist.org/packages/vegas-cmf/apidoc)[![Total Downloads](https://camo.githubusercontent.com/9a7a9aa0d2b0590b4c8e93a3477fcd4bf7216794729349f31944f2ad1ce2b89b/68747470733a2f2f706f7365722e707567782e6f72672f76656761732d636d662f617069646f632f646f776e6c6f6164732e706e67)](https://packagist.org/packages/vegas-cmf/apidoc)[![SensioLabsInsight](https://camo.githubusercontent.com/592e16cfd0de8b2ae28d1531b5c80097bf8348c98e64716d9c1d98e4bc93588e/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f33666337323832382d636139322d346434652d393065302d3964633463356566363438312f6d696e692e706e67)](https://insight.sensiolabs.com/projects/3fc72828-ca92-4d4e-90e0-9dc4c5ef6481)

Usage
-----

[](#usage)

#### Add vegas-cmf/apidoc to composer.json dependencies

[](#add-vegas-cmfapidoc-to-composerjson-dependencies)

```
"vegas-cmf/apidoc" : "1.0.*"

```

and run composer update

```
php composer.phar update

```

#### Create CLI task which extends \\Vegas\\ApiDoc\\Task\\GeneratorTaskAbstract.php

[](#create-cli-task-which-extends-vegasapidoctaskgeneratortaskabstractphp)

```
mkdir app/tasks

touch app/tasks/ApidocTask.php

```

```
//app/tasks/ApidocTask.php
use Vegas\Cli\Task\Option;
use Vegas\Mvc\View;

class ApidocTask extends \Vegas\ApiDoc\Task\GeneratorTaskAbstract
{
    protected function getView()
    {
        $view = new View($this->di->get('config')->application->view->toArray());
        $view->setDI($this->di);

        return $view;
    }

    protected function getOutputPath()
    {
        return APP_ROOT . '/public/apiDoc/';
    }

    protected function getLayoutFilePath()
    {
        return APP_ROOT . '/app/layouts/partials/apiDoc/layout';
    }

    protected function getInputPath()
    {
        return APP_ROOT . '/app/modules';
    }
}
```

#### Add annotations to controllers classes

[](#add-annotations-to-controllers-classes)

```