Document

Extends \ezcDocumentRst

This is a customized RestructuredText document to register Scrybe-specific directives, roles and options.

The following directives are introduced using this class:

  • toctree, a directive used to insert table of contents into documents.
  • image, an overridden version of image that collects the assets.
  • figure, an overridden version of the figure that collects the assets.

The following roles are introduced in this class:

  • doc, a reference to an external piece of documentation.
package

Default

Methods

Sets the Scrybe-specific options, registers the roles and directives and loads the file.

__construct(\phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface $converter, \phpDocumentor\Fileset\File $file) 

Arguments

$file

\phpDocumentor\Fileset\File

Returns the converter responsible for converting this object.

getConverter() : \phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface

Returns the file associated with this document.

getFile() : \phpDocumentor\Fileset\File

Response

\phpDocumentor\Fileset\File

Sends the errors of the given Rst document to the logger as a block.

logStats(\Exception|null $fatal, \Monolog\Logger $logger) : void

If a fatal error occurred then this can be passed as the $fatal argument and is shown as such.

Arguments

$fatal

\Exception|null

$logger

\Monolog\Logger

Properties

Fileset containing the project root and list of files in this run.

file : \phpDocumentor\Fileset\File
var

Type(s)

\phpDocumentor\Fileset\File

Converter used to retrieve global assets from.

converter : \phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface

The converter contains global assets, such as the Table of Contents, that can be used in directives and roles.

var

Type(s)

\phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface

options

options : \ezcDocumentRstOptions

Type(s)

\ezcDocumentRstOptions