PHP Classes

File: docs/usage.rst

Recommend this page to a friend!
  Classes of Francesco Danti   Sphinx PHP Doc RST   docs/usage.rst   Download  
File: docs/usage.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: 5 years ago
Size: 664 bytes
 

Contents

Class file image Download 
Usage
=====

You can either use the :ref:`cli` or create your own PHP script if you want to have more control over the generated documentation.


.. code-block:: php

    use JuliusHaertl\PHPDocToRst\ApiDocBuilder;

    $apiDocBuilder = new ApiDocBuilder(__DIR__ . '/src', __DIR__ . '/docs');
    $apiDocBuilder->setVerboseOutput(true);
    $apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\InterfaceImplementors::class);
    $apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\PublicOnlyExtension::class);
    $apiDocBuilder->build();


For more details on extensions that can be used, please check the :ref:`extensions` documentation.