Browse Source

final cleanup apidoc generator

tags/2.0.0-beta
Carsten Brandt 11 years ago
parent
commit
c7c4d3c075
  1. 6
      extensions/yii/apidoc/commands/RenderController.php
  2. 1
      extensions/yii/apidoc/helpers/Markdown.php
  3. 1
      extensions/yii/apidoc/models/BaseDoc.php
  4. 1
      extensions/yii/apidoc/models/ClassDoc.php
  5. 1
      extensions/yii/apidoc/models/ConstDoc.php
  6. 1
      extensions/yii/apidoc/models/EventDoc.php
  7. 1
      extensions/yii/apidoc/models/FunctionDoc.php
  8. 1
      extensions/yii/apidoc/models/InterfaceDoc.php
  9. 1
      extensions/yii/apidoc/models/MethodDoc.php
  10. 1
      extensions/yii/apidoc/models/ParamDoc.php
  11. 1
      extensions/yii/apidoc/models/PropertyDoc.php
  12. 1
      extensions/yii/apidoc/models/TraitDoc.php
  13. 1
      extensions/yii/apidoc/models/TypeDoc.php

6
extensions/yii/apidoc/commands/RenderController.php

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

1
extensions/yii/apidoc/helpers/Markdown.php

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

1
extensions/yii/apidoc/models/BaseDoc.php

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

1
extensions/yii/apidoc/models/ClassDoc.php

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

1
extensions/yii/apidoc/models/ConstDoc.php

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

1
extensions/yii/apidoc/models/EventDoc.php

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

1
extensions/yii/apidoc/models/FunctionDoc.php

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

1
extensions/yii/apidoc/models/InterfaceDoc.php

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

1
extensions/yii/apidoc/models/MethodDoc.php

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

1
extensions/yii/apidoc/models/ParamDoc.php

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

1
extensions/yii/apidoc/models/PropertyDoc.php

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

1
extensions/yii/apidoc/models/TraitDoc.php

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

1
extensions/yii/apidoc/models/TypeDoc.php

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

Loading…
Cancel
Save