final cleanup apidoc generator

This commit is contained in:
Carsten Brandt
2014-01-06 05:37:43 +01:00
parent 2245a7e36d
commit c7c4d3c075
13 changed files with 13 additions and 5 deletions

View File

@ -129,11 +129,7 @@ class RenderController extends Controller
return null; return null;
}, },
'only' => ['.php'], 'only' => ['.php'],
'except' => array_merge($except, [ 'except' => $except,
'/views/',
'/requirements/',
'/gii/generators/',
]),
]; ];
return FileHelper::findFiles($path, $options); return FileHelper::findFiles($path, $options);
} }

View File

@ -13,6 +13,7 @@ use yii\apidoc\models\TypeDoc;
use yii\apidoc\templates\BaseRenderer; use yii\apidoc\templates\BaseRenderer;
/** /**
* A Markdown helper with support for class reference links.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -12,6 +12,7 @@ use phpDocumentor\Reflection\DocBlock\Tag\SinceTag;
use yii\base\Object; use yii\base\Object;
/** /**
* Base class for API documentation information.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -8,6 +8,7 @@
namespace yii\apidoc\models; namespace yii\apidoc\models;
/** /**
* Represents API documentation information for a `class`.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -8,6 +8,7 @@
namespace yii\apidoc\models; namespace yii\apidoc\models;
/** /**
* Represents API documentation information for a `constant`.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -11,6 +11,7 @@ use phpDocumentor\Reflection\DocBlock\Tag\ParamTag;
use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag; use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
/** /**
* Represents API documentation information for an `event`.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -14,6 +14,7 @@ use phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag;
use yii\base\Exception; use yii\base\Exception;
/** /**
* Represents API documentation information for a `function`.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -8,6 +8,7 @@
namespace yii\apidoc\models; namespace yii\apidoc\models;
/** /**
* Represents API documentation information for an `interface`.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -8,6 +8,7 @@
namespace yii\apidoc\models; namespace yii\apidoc\models;
/** /**
* Represents API documentation information for a `method`.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -11,6 +11,7 @@ use yii\apidoc\helpers\PrettyPrinter;
use yii\base\Object; use yii\base\Object;
/** /**
* Represents API documentation information for a [[FunctionDoc|function]] or [[MethodDoc|method]] `param`.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -11,6 +11,7 @@ use phpDocumentor\Reflection\DocBlock\Tag\VarTag;
use yii\apidoc\helpers\PrettyPrinter; use yii\apidoc\helpers\PrettyPrinter;
/** /**
* Represents API documentation information for a `property`.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -8,6 +8,7 @@
namespace yii\apidoc\models; namespace yii\apidoc\models;
/** /**
* Represents API documentation information for a `trait`.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0

View File

@ -12,6 +12,7 @@ use yii\base\Exception;
use yii\helpers\StringHelper; use yii\helpers\StringHelper;
/** /**
* Base class for API documentation information for classes, interfaces and traits.
* *
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0