renamed phpdoc extension to apidoc

extensions/yii/apidoc/CHANGELOG.md

@@ -1,4 +1,4 @@
-Yii Framework 2 phpdoc extension Change Log
+Yii Framework 2 apidoc extension Change Log
 ===========================================
 
 2.0.0 beta under development

extensions/yii/apidoc/README.md

@@ -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.

extensions/yii/apidoc/assets/css/style.css

@@ -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;
 }

extensions/yii/apidoc/commands/PhpdocController.php

@@ -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\apidoc\components\OfflineRenderer;
-use yii\phpdoc\models\Context;
+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

extensions/yii/apidoc/components/BaseRenderer.php

@@ -1,17 +1,16 @@
 <?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\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

extensions/yii/apidoc/components/OfflineRenderer.php

@@ -1,11 +1,11 @@
 <?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;
@@ -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\apidoc\models\ClassDoc;
-use yii\phpdoc\models\Context;
+use yii\apidoc\models\Context;
 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
 {

extensions/yii/apidoc/composer.json

@@ -1,11 +1,11 @@
 {
-	"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",
 	"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"
 }

extensions/yii/apidoc/models/BaseDoc.php

@@ -1,6 +1,11 @@
 <?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;
 

extensions/yii/apidoc/models/ClassDoc.php

@@ -1,6 +1,11 @@
 <?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

extensions/yii/apidoc/models/Context.php

@@ -1,11 +1,11 @@
 <?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;

extensions/yii/apidoc/models/EventDoc.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\apidoc\models;
+
+class EventDoc extends BaseDoc
+{
+	public $isInherited;
+	public $definedBy;
+	public $trigger;
+}

extensions/yii/apidoc/models/File.php

@@ -1,6 +1,11 @@
 <?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;

extensions/yii/apidoc/models/FunctionDoc.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\apidoc\models;
+
+class FunctionDoc extends BaseDoc
+{
+	public $signature;
+	public $input=array();
+	public $output;
+}

extensions/yii/apidoc/models/InterfaceDoc.php

@@ -1,11 +1,11 @@
 <?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
 {

extensions/yii/apidoc/models/MethodDoc.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\apidoc\models;
+
+class MethodDoc extends FunctionDoc
+{
+	public $isAbstract;
+	public $isFinal;
+	public $isProtected;
+	public $isStatic;
+	public $isInherited;
+	public $definedBy;
+}

extensions/yii/apidoc/models/ParamDoc.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\apidoc\models;
+
+class ParamDoc
+{
+	public $name;
+	public $description;
+	public $type;
+	public $isOptional;
+	public $defaultValue;
+	public $isPassedByReference;
+}

extensions/yii/apidoc/models/PropertyDoc.php

@@ -1,11 +1,11 @@
 <?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
 {

extensions/yii/apidoc/models/TraitDoc.php

@@ -1,11 +1,11 @@
 <?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
 {

extensions/yii/apidoc/views/class.php

@@ -1,8 +1,8 @@
 <?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 yii\web\View $this

extensions/yii/apidoc/views/classSummary.php

@@ -1,8 +1,8 @@
 <?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 yii\web\View $this

extensions/yii/apidoc/views/index.php

@@ -1,8 +1,8 @@
 <?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 yii\web\View $this

extensions/yii/phpdoc/models/EventDoc.php

@@ -1,10 +0,0 @@
-<?php
-
-namespace yii\phpdoc\models;
-
-class EventDoc extends BaseDoc
-{
-	public $isInherited;
-	public $definedBy;
-	public $trigger;
-}

extensions/yii/phpdoc/models/FunctionDoc.php

@@ -1,10 +0,0 @@
-<?php
-
-namespace yii\phpdoc\models;
-
-class FunctionDoc extends BaseDoc
-{
-	public $signature;
-	public $input=array();
-	public $output;
-}

extensions/yii/phpdoc/models/MethodDoc.php

@@ -1,13 +0,0 @@
-<?php
-
-namespace yii\phpdoc\models;
-
-class MethodDoc extends FunctionDoc
-{
-	public $isAbstract;
-	public $isFinal;
-	public $isProtected;
-	public $isStatic;
-	public $isInherited;
-	public $definedBy;
-}

extensions/yii/phpdoc/models/ParamDoc.php

@@ -1,18 +0,0 @@
-<?php
-/**
- * 
- * 
- * @author Carsten Brandt <mail@cebe.cc>
- */
-
-namespace yii\phpdoc\models;
-
-class ParamDoc
-{
-	public $name;
-	public $description;
-	public $type;
-	public $isOptional;
-	public $defaultValue;
-	public $isPassedByReference;
-}