\phpDocumentor\Plugin\Scrybe\Converter\RestructuredText\RolesDoc

The :doc: role creates a link to an external document.

For this link you can either use relative locations or an absolute notation. The absolute notation uses the documentation root as starting directory.

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 text role to docbook.

Create a docbook XML structure at the text roles position in the document.

Parameters

\DOMDocument $document
\DOMElement $root

toXhtml()

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

Transform text role to HTML.

Create a XHTML structure at the text roles position in the document.

Parameters

\DOMDocument $document
\DOMElement $root