\phpDocumentor\Plugin\Scrybe\Converter\RestructuredText\DirectivesCodeBlock

Directive used to process `.

. toctree::` and insert entries from the table of contents.

This directive tries to match the file with an entry in the table of contents during the creation phase. If a document is found it will generate a mini-table of contents at that location with the depth given using the :maxdepth: parameter.

This directive is inspired by Sphinx' toctree directive.

Summary

Methods
Properties
Constants
toDocbook()
toXhtml()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

toDocbook()

toDocbook(\DOMDocument  $document, \DOMElement  $root) : void

Transform directive to Docbook.

Create a docbook XML structure at the directives position in the document.

Parameters

\DOMDocument $document
\DOMElement $root

toXhtml()

toXhtml(\DOMDocument  $document, \DOMElement  $root) : void

Transform directive to HTML

Create a XHTML structure at the directives position in the document.

Parameters

\DOMDocument $document
\DOMElement $root