Commit b17c8270 by Carsten Brandt

renamed phpdoc extension to apidoc

parent 63e72623
Yii Framework 2 phpdoc extension Change Log
Yii Framework 2 apidoc extension Change Log
===========================================
2.0.0 beta under development
......
......@@ -11,13 +11,13 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run
```
php composer.phar require yiisoft/yii2-phpdoc "*"
php composer.phar require yiisoft/yii2-apidoc "*"
```
or add
```json
"yiisoft/yii2-phpdoc": "*"
"yiisoft/yii2-apidoc": "*"
```
to the require section of your composer.json.
......
......@@ -4,7 +4,7 @@ body
body, div, span, p, input
{
font-family: Verdana, sans-serif, Arial;
font-family: Verdana, Arial, sans-serif;
font-size: 10pt;
color: #333333;
}
......
......@@ -5,20 +5,19 @@
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\commands;
namespace yii\apidoc\commands;
use phpDocumentor\Reflection\FileReflector;
use yii\console\Controller;
use yii\helpers\Console;
use yii\helpers\FileHelper;
use yii\phpdoc\components\OfflineRenderer;
use yii\phpdoc\models\Context;
use yii\apidoc\components\OfflineRenderer;
use yii\apidoc\models\Context;
use Yii;
/**
*
* @author Carsten Brandt <mail@cebe.cc>
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class PhpdocController extends Controller
......
<?php
/**
*
*
* @author Carsten Brandt <mail@cebe.cc>
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\components;
namespace yii\apidoc\components;
use Yii;
use yii\base\Component;
use yii\console\Controller;
use yii\phpdoc\models\Context;
use yii\apidoc\models\Context;
use yii\web\View;
abstract class BaseRenderer extends Component
......
<?php
/**
*
*
* @author Carsten Brandt <mail@cebe.cc>
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\components;
namespace yii\apidoc\components;
use yii\base\ViewContextInterface;
......@@ -13,11 +13,11 @@ use yii\console\Controller;
use yii\helpers\Console;
use yii\helpers\FileHelper;
use yii\helpers\Html;
use yii\phpdoc\models\ClassDoc;
use yii\phpdoc\models\Context;
use yii\apidoc\models\ClassDoc;
use yii\apidoc\models\Context;
use Yii;
use yii\phpdoc\models\InterfaceDoc;
use yii\phpdoc\models\TraitDoc;
use yii\apidoc\models\InterfaceDoc;
use yii\apidoc\models\TraitDoc;
class OfflineRenderer extends BaseRenderer implements ViewContextInterface
{
......
{
"name": "yiisoft/yii2-phpdoc",
"description": "PHP Documentation generator for the Yii framework 2.0",
"keywords": ["yii", "phpdoc", "api", "documentation"],
"name": "yiisoft/yii2-apidoc",
"description": "API Documentation generator for the Yii framework 2.0",
"keywords": ["yii", "phpdoc", "apidoc", "api", "documentation"],
"type": "yii2-extension",
"license": "BSD-3-Clause",
"support": {
"issues": "https://github.com/yiisoft/yii2/issues?labels=ext%3Aredis",
"issues": "https://github.com/yiisoft/yii2/issues?labels=ext%3Aapidoc",
"forum": "http://www.yiiframework.com/forum/",
"wiki": "http://www.yiiframework.com/wiki/",
"irc": "irc://irc.freenode.net/yii",
......@@ -23,7 +23,7 @@
"phpdocumentor/reflection": "1.0.2"
},
"autoload": {
"psr-0": { "yii\\redis\\": "" }
"psr-0": { "yii\\apidoc\\": "" }
},
"target-dir": "yii/redis"
"target-dir": "yii/apidoc"
}
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
use yii\base\Object;
......
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
/**
* Class ClassDoc
......
<?php
/**
*
*
* @author Carsten Brandt <mail@cebe.cc>
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
use yii\base\Component;
......
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
class EventDoc extends BaseDoc
{
......
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
use phpDocumentor\Reflection\FileReflector;
use yii\base\Object;
......
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
class FunctionDoc extends BaseDoc
{
......
<?php
/**
*
*
* @author Carsten Brandt <mail@cebe.cc>
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
class InterfaceDoc extends BaseDoc
{
......
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
class MethodDoc extends FunctionDoc
{
......
<?php
/**
*
*
* @author Carsten Brandt <mail@cebe.cc>
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
class ParamDoc
{
......
<?php
/**
*
*
* @author Carsten Brandt <mail@cebe.cc>
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
class PropertyDoc extends BaseDoc
{
......
<?php
/**
*
*
* @author Carsten Brandt <mail@cebe.cc>
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\phpdoc\models;
namespace yii\apidoc\models;
class TraitDoc extends BaseDoc
{
......
<?php
use yii\phpdoc\models\ClassDoc;
use yii\phpdoc\models\InterfaceDoc;
use yii\phpdoc\models\TraitDoc;
use yii\apidoc\models\ClassDoc;
use yii\apidoc\models\InterfaceDoc;
use yii\apidoc\models\TraitDoc;
/**
* @var ClassDoc|InterfaceDoc|TraitDoc $item
* @var yii\web\View $this
......
<?php
use yii\phpdoc\models\ClassDoc;
use yii\phpdoc\models\InterfaceDoc;
use yii\phpdoc\models\TraitDoc;
use yii\apidoc\models\ClassDoc;
use yii\apidoc\models\InterfaceDoc;
use yii\apidoc\models\TraitDoc;
/**
* @var ClassDoc|InterfaceDoc|TraitDoc $item
* @var yii\web\View $this
......
<?php
use yii\phpdoc\models\ClassDoc;
use yii\phpdoc\models\InterfaceDoc;
use yii\phpdoc\models\TraitDoc;
use yii\apidoc\models\ClassDoc;
use yii\apidoc\models\InterfaceDoc;
use yii\apidoc\models\TraitDoc;
/**
* @var ClassDoc[]|InterfaceDoc[]|TraitDoc[] $items
* @var yii\web\View $this
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment