yiisoft/yii2-apidoc API Documentation 2.1

This is the API Documentation for the yiisoft/yii2-apidoc extension. Here you will find detailed information about all classes provided by this extension. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 2.1 of the extension. You can use the dropdown menu on the top right to switch between versions.

Class	Description
yii\apidoc\commands\ApiController	Generate class API documentation.
yii\apidoc\commands\GuideController	This command can render documentation stored as markdown files such as the yii guide or your own applications documentation setup.
yii\apidoc\components\BaseController	Command to render API Documentation files
yii\apidoc\helpers\ApiIndexer	ApiIndexer indexes framework API
yii\apidoc\helpers\ApiMarkdown	A Markdown helper with support for class reference links.
yii\apidoc\helpers\ApiMarkdownLaTeX	A Markdown helper with support for class reference links.
yii\apidoc\helpers\ApiMarkdownTrait	Class ApiMarkdownTrait
yii\apidoc\helpers\IndexFileAnalyzer	IndexFileAnalyzer analyzes index file with TOC. Typically README.md.
yii\apidoc\helpers\MarkdownHighlightTrait	MarkdownHighlightTrait provides code highlighting functionality for Markdown Parsers.
yii\apidoc\helpers\PrettyPrinter	Enhances the phpDocumentor PrettyPrinter with short array syntax
yii\apidoc\models\BaseDoc	Base class for API documentation information.
yii\apidoc\models\ClassDoc	Represents API documentation information for a class.
yii\apidoc\models\ConstDoc	Represents API documentation information for a constant.
yii\apidoc\models\Context
yii\apidoc\models\EventDoc	Represents API documentation information for an event.
yii\apidoc\models\FunctionDoc	Represents API documentation information for a function.
yii\apidoc\models\InterfaceDoc	Represents API documentation information for an interface.
yii\apidoc\models\MethodDoc	Represents API documentation information for a method.
yii\apidoc\models\ParamDoc	Represents API documentation information for a function or method param.
yii\apidoc\models\PropertyDoc	Represents API documentation information for a property.
yii\apidoc\models\TraitDoc	Represents API documentation information for a trait.
yii\apidoc\models\TypeDoc	Base class for API documentation information for classes, interfaces and traits.
yii\apidoc\renderers\ApiRenderer	Base class for all API documentation renderers
yii\apidoc\renderers\BaseRenderer	Base class for all documentation renderers
yii\apidoc\renderers\GuideRenderer	Base class for all Guide documentation renderers
yii\apidoc\templates\bootstrap\ApiRenderer
yii\apidoc\templates\bootstrap\GuideRenderer
yii\apidoc\templates\bootstrap\RendererTrait	Common methods for renderers
yii\apidoc\templates\bootstrap\SideNavWidget	Nav renders a nav HTML component.
yii\apidoc\templates\bootstrap\assets\AssetBundle	The asset bundle for the offline template.
yii\apidoc\templates\bootstrap\assets\HighlightBundle	The asset bundle for the highlight.js styles.
yii\apidoc\templates\bootstrap\assets\JsSearchAsset	The asset bundle for the offline template.
yii\apidoc\templates\html\ApiRenderer	The base class for HTML API documentation renderers.
yii\apidoc\templates\html\GuideRenderer
yii\apidoc\templates\json\ApiRenderer	The class for outputting documentation data structures as a JSON text.
yii\apidoc\templates\online\ApiRenderer
yii\apidoc\templates\pdf\GuideRenderer