From c7c4d3c075bf1e1be1847ed61b248737f3bd81b8 Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Mon, 6 Jan 2014 05:37:43 +0100 Subject: [PATCH] final cleanup apidoc generator --- extensions/yii/apidoc/commands/RenderController.php | 6 +----- extensions/yii/apidoc/helpers/Markdown.php | 1 + extensions/yii/apidoc/models/BaseDoc.php | 1 + extensions/yii/apidoc/models/ClassDoc.php | 1 + extensions/yii/apidoc/models/ConstDoc.php | 1 + extensions/yii/apidoc/models/EventDoc.php | 1 + extensions/yii/apidoc/models/FunctionDoc.php | 1 + extensions/yii/apidoc/models/InterfaceDoc.php | 1 + extensions/yii/apidoc/models/MethodDoc.php | 1 + extensions/yii/apidoc/models/ParamDoc.php | 1 + extensions/yii/apidoc/models/PropertyDoc.php | 1 + extensions/yii/apidoc/models/TraitDoc.php | 1 + extensions/yii/apidoc/models/TypeDoc.php | 1 + 13 files changed, 13 insertions(+), 5 deletions(-) diff --git a/extensions/yii/apidoc/commands/RenderController.php b/extensions/yii/apidoc/commands/RenderController.php index 8a46de3..cbd97ae 100644 --- a/extensions/yii/apidoc/commands/RenderController.php +++ b/extensions/yii/apidoc/commands/RenderController.php @@ -129,11 +129,7 @@ class RenderController extends Controller return null; }, 'only' => ['.php'], - 'except' => array_merge($except, [ - '/views/', - '/requirements/', - '/gii/generators/', - ]), + 'except' => $except, ]; return FileHelper::findFiles($path, $options); } diff --git a/extensions/yii/apidoc/helpers/Markdown.php b/extensions/yii/apidoc/helpers/Markdown.php index 682603d..6139b15 100644 --- a/extensions/yii/apidoc/helpers/Markdown.php +++ b/extensions/yii/apidoc/helpers/Markdown.php @@ -13,6 +13,7 @@ use yii\apidoc\models\TypeDoc; use yii\apidoc\templates\BaseRenderer; /** + * A Markdown helper with support for class reference links. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/BaseDoc.php b/extensions/yii/apidoc/models/BaseDoc.php index c470ab5..9c8cfb9 100644 --- a/extensions/yii/apidoc/models/BaseDoc.php +++ b/extensions/yii/apidoc/models/BaseDoc.php @@ -12,6 +12,7 @@ use phpDocumentor\Reflection\DocBlock\Tag\SinceTag; use yii\base\Object; /** + * Base class for API documentation information. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/ClassDoc.php b/extensions/yii/apidoc/models/ClassDoc.php index d9b17a4..020105f 100644 --- a/extensions/yii/apidoc/models/ClassDoc.php +++ b/extensions/yii/apidoc/models/ClassDoc.php @@ -8,6 +8,7 @@ namespace yii\apidoc\models; /** + * Represents API documentation information for a `class`. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/ConstDoc.php b/extensions/yii/apidoc/models/ConstDoc.php index a0fbf08..1f185da 100644 --- a/extensions/yii/apidoc/models/ConstDoc.php +++ b/extensions/yii/apidoc/models/ConstDoc.php @@ -8,6 +8,7 @@ namespace yii\apidoc\models; /** + * Represents API documentation information for a `constant`. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/EventDoc.php b/extensions/yii/apidoc/models/EventDoc.php index 41771c5..2c15f3d 100644 --- a/extensions/yii/apidoc/models/EventDoc.php +++ b/extensions/yii/apidoc/models/EventDoc.php @@ -11,6 +11,7 @@ use phpDocumentor\Reflection\DocBlock\Tag\ParamTag; use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag; /** + * Represents API documentation information for an `event`. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/FunctionDoc.php b/extensions/yii/apidoc/models/FunctionDoc.php index 232d236..82c09ec 100644 --- a/extensions/yii/apidoc/models/FunctionDoc.php +++ b/extensions/yii/apidoc/models/FunctionDoc.php @@ -14,6 +14,7 @@ use phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag; use yii\base\Exception; /** + * Represents API documentation information for a `function`. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/InterfaceDoc.php b/extensions/yii/apidoc/models/InterfaceDoc.php index 57cd9ce..10b6d65 100644 --- a/extensions/yii/apidoc/models/InterfaceDoc.php +++ b/extensions/yii/apidoc/models/InterfaceDoc.php @@ -8,6 +8,7 @@ namespace yii\apidoc\models; /** + * Represents API documentation information for an `interface`. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/MethodDoc.php b/extensions/yii/apidoc/models/MethodDoc.php index 0f7288f..e31d31c 100644 --- a/extensions/yii/apidoc/models/MethodDoc.php +++ b/extensions/yii/apidoc/models/MethodDoc.php @@ -8,6 +8,7 @@ namespace yii\apidoc\models; /** + * Represents API documentation information for a `method`. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/ParamDoc.php b/extensions/yii/apidoc/models/ParamDoc.php index 2be9de8..de6ef5d 100644 --- a/extensions/yii/apidoc/models/ParamDoc.php +++ b/extensions/yii/apidoc/models/ParamDoc.php @@ -11,6 +11,7 @@ use yii\apidoc\helpers\PrettyPrinter; use yii\base\Object; /** + * Represents API documentation information for a [[FunctionDoc|function]] or [[MethodDoc|method]] `param`. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/PropertyDoc.php b/extensions/yii/apidoc/models/PropertyDoc.php index dbe4a20..b865fba 100644 --- a/extensions/yii/apidoc/models/PropertyDoc.php +++ b/extensions/yii/apidoc/models/PropertyDoc.php @@ -11,6 +11,7 @@ use phpDocumentor\Reflection\DocBlock\Tag\VarTag; use yii\apidoc\helpers\PrettyPrinter; /** + * Represents API documentation information for a `property`. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/TraitDoc.php b/extensions/yii/apidoc/models/TraitDoc.php index 37f1799..1169f99 100644 --- a/extensions/yii/apidoc/models/TraitDoc.php +++ b/extensions/yii/apidoc/models/TraitDoc.php @@ -8,6 +8,7 @@ namespace yii\apidoc\models; /** + * Represents API documentation information for a `trait`. * * @author Carsten Brandt * @since 2.0 diff --git a/extensions/yii/apidoc/models/TypeDoc.php b/extensions/yii/apidoc/models/TypeDoc.php index a4c68d2..6561fc7 100644 --- a/extensions/yii/apidoc/models/TypeDoc.php +++ b/extensions/yii/apidoc/models/TypeDoc.php @@ -12,6 +12,7 @@ use yii\base\Exception; use yii\helpers\StringHelper; /** + * Base class for API documentation information for classes, interfaces and traits. * * @author Carsten Brandt * @since 2.0