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