File: docs/extensions.rst

Recommend this page to a friend!
  Classes of Francesco Danti  >  Sphinx PHP Doc RST  >  docs/extensions.rst  >  Download  
File: docs/extensions.rst
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: Sphinx PHP Doc RST
Generate Sphinx documentation from PHPDoc comments
Author: By
Last change:
Date: 11 months ago
Size: 827 bytes
 

Contents

Class file image Download
.. _extensions:

Extensions
==========

Available extensions
--------------------

The following extensions are shipped with phpdoc-to-rst:

* :php:class:`InterfaceImplementors<JuliusHaertl\\PHPDocToRst\\Extension\\InterfaceImplementors>`
    Link a list of all classes that implement an interface.
* :php:class:`PublicOnlyExtension<JuliusHaertl\\PHPDocToRst\\Extension\\PublicOnlyExtension>`
    Only show public methods/properties. Also anything tagged with @internal will be hidden.
* :php:class:`TocExtension<JuliusHaertl\\PHPDocToRst\\Extension\\TocExtension>`
    Add a list of methods to the beginning of each interface/class/trait


Building an extension
---------------------

You can easily build your own extensions just by extending the :php:class:`Extension<JuliusHaertl\\PHPDocToRst\\Extension\\Extension>` class.

For more information send a message to info at phpclasses dot org.