Skip to content

Commit

Permalink
verified correct rst syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
@abbadon1334
abbadon1334 committed Jul 11, 2019
1 parent 1c5d9e2 commit 62ff8d6
Show file tree
Hide file tree
Showing 24 changed files with 757 additions and 40 deletions.
1 change: 0 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/abbadon1334/phpdoc-to-rst/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/abbadon1334/phpdoc-to-rst/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/abbadon1334/phpdoc-to-rst/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/abbadon1334/phpdoc-to-rst/?branch=master)
[![Build Status](https://scrutinizer-ci.com/g/abbadon1334/phpdoc-to-rst/badges/build.png?b=master)](https://scrutinizer-ci.com/g/abbadon1334/phpdoc-to-rst/build-status/master)
[![Code Intelligence Status](https://scrutinizer-ci.com/g/abbadon1334/phpdoc-to-rst/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)

Forked and refactor by Francesco "Abbadon1334" Danti.

Expand Down
126 changes: 116 additions & 10 deletions docs/api/JuliusHaertl/PHPDocToRst/ApiDocBuilder.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,67 +18,128 @@ ApiDocBuilder
.. rst-class:: phpdoc-description

| This class is used to parse a project tree and generate rst files
| for all of the containing PHP structures
| for all of the containing PHP structures\.
| Example usage is documented in examples/example\.php

:Source:
`/ApiDocBuilder.php#49 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L49>`_



Summary
-------

Methods
~~~~~~~

* :php:meth:`public \_\_construct\($srcDir, $dstDir\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::\_\_construct\(\)>`
* :php:meth:`public build\(\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::build\(\)>`
* :php:meth:`private setupReflection\(\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::setupReflection\(\)>`
* :php:meth:`public log\($message\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::log\(\)>`
* :php:meth:`private createDirectoryStructure\(\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::createDirectoryStructure\(\)>`
* :php:meth:`private parseFiles\(\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::parseFiles\(\)>`
* :php:meth:`public debug\($message\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::debug\(\)>`
* :php:meth:`private buildIndexes\(\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::buildIndexes\(\)>`
* :php:meth:`public setVerboseOutput\($v\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::setVerboseOutput\(\)>`
* :php:meth:`public setDebugOutput\($v\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::setDebugOutput\(\)>`
* :php:meth:`public addExtension\($class, $arguments\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::addExtension\(\)>`
* :php:meth:`private parseInterfaces\($file\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::parseInterfaces\(\)>`
* :php:meth:`private parseClasses\($file\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::parseClasses\(\)>`
* :php:meth:`private parseTraits\($file\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::parseTraits\(\)>`
* :php:meth:`private parseFunctions\($file\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::parseFunctions\(\)>`
* :php:meth:`private parseConstants\($file\)<JuliusHaertl\\PHPDocToRst\\ApiDocBuilder::parseConstants\(\)>`


Properties
----------

.. php:attr:: private static project
:Source:
`/ApiDocBuilder.php#52 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L52>`_

:Type: :any:`\\phpDocumentor\\Reflection\\Php\\Project <phpDocumentor\\Reflection\\Php\\Project>`


.. php:attr:: private static docFiles
:Source:
`/ApiDocBuilder.php#55 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L55>`_

:Type: array


.. php:attr:: private static constants
:Source:
`/ApiDocBuilder.php#58 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L58>`_

:Type: array


.. php:attr:: private static functions
:Source:
`/ApiDocBuilder.php#61 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L61>`_

:Type: array


.. php:attr:: private static extensions
:Source:
`/ApiDocBuilder.php#64 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L64>`_

:Type: :any:`\\JuliusHaertl\\PHPDocToRst\\Extension\\Extension\[\] <JuliusHaertl\\PHPDocToRst\\Extension\\Extension>`


.. php:attr:: private static extensionNames
:Source:
`/ApiDocBuilder.php#67 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L67>`_

:Type: string[]


.. php:attr:: private static extensionArguments
:Source:
`/ApiDocBuilder.php#70 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L70>`_

:Type: array[]


.. php:attr:: private static srcDir
:Source:
`/ApiDocBuilder.php#73 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L73>`_

:Type: string[]


.. php:attr:: private static dstDir
:Source:
`/ApiDocBuilder.php#76 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L76>`_

:Type: string


.. php:attr:: private static verboseOutput
:Source:
`/ApiDocBuilder.php#79 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L79>`_

:Type: bool


.. php:attr:: private static debugOutput
:Source:
`/ApiDocBuilder.php#82 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L82>`_

:Type: bool


Expand All @@ -94,6 +155,9 @@ Methods
| ApiDocBuilder constructor\.

:Source:
`/ApiDocBuilder.php#90 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L90>`_


:Parameters:
* **$srcDir** (string[]) array of paths that should be analysed
Expand All @@ -109,9 +173,12 @@ Methods
.. rst-class:: phpdoc-description

| Run this to build the documentation
| Run this to build the documentation\.

:Source:
`/ApiDocBuilder.php#99 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L99>`_




Expand All @@ -120,6 +187,9 @@ Methods

.. php:method:: private setupReflection()
:Source:
`/ApiDocBuilder.php#112 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L112>`_


:Throws: :any:`\\Exception <Exception>`

Expand All @@ -131,9 +201,12 @@ Methods
.. rst-class:: phpdoc-description

| Log a message
| Log a message\.

:Source:
`/ApiDocBuilder.php#166 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L166>`_


:Parameters:
* **$message** (string) Message to be logged
Expand All @@ -148,9 +221,12 @@ Methods
.. rst-class:: phpdoc-description

| Create directory structure for the rst output
| Create directory structure for the rst output\.

:Source:
`/ApiDocBuilder.php#178 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L178>`_


:Throws: :any:`\\JuliusHaertl\\PHPDocToRst\\WriteException <JuliusHaertl\\PHPDocToRst\\WriteException>`

Expand All @@ -160,6 +236,9 @@ Methods

.. php:method:: private parseFiles()
:Source:
`/ApiDocBuilder.php#191 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L191>`_




Expand All @@ -170,9 +249,12 @@ Methods
.. rst-class:: phpdoc-description

| Log a debug message
| Log a debug message\.

:Source:
`/ApiDocBuilder.php#218 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L218>`_


:Parameters:
* **$message** (string) Message to be logged
Expand All @@ -185,6 +267,9 @@ Methods

.. php:method:: private buildIndexes()
:Source:
`/ApiDocBuilder.php#225 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L225>`_




Expand All @@ -195,9 +280,12 @@ Methods
.. rst-class:: phpdoc-description

| Enable verbose logging output
| Enable verbose logging output\.

:Source:
`/ApiDocBuilder.php#263 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L263>`_


:Parameters:
* **$v** (bool) Set to true to enable
Expand All @@ -212,9 +300,12 @@ Methods
.. rst-class:: phpdoc-description

| Enable debug logging output
| Enable debug logging output\.

:Source:
`/ApiDocBuilder.php#273 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L273>`_


:Parameters:
* **$v** (bool) Set to true to enable
Expand All @@ -227,6 +318,9 @@ Methods

.. php:method:: public addExtension( $class, $arguments=\[\])
:Source:
`/ApiDocBuilder.php#283 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L283>`_


:Parameters:
* **$class** (string) name of the extension class
Expand All @@ -240,32 +334,39 @@ Methods

.. php:method:: private parseInterfaces( $file)
:Source:
`/ApiDocBuilder.php#292 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L292>`_


:Parameters:
* **$file** (:any:`phpDocumentor\\Reflection\\Php\\File <phpDocumentor\\Reflection\\Php\\File>`)


:Returns: array



.. rst-class:: private

.. php:method:: private parseClasses( $file)
:Source:
`/ApiDocBuilder.php#312 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L312>`_


:Parameters:
* **$file** (:any:`phpDocumentor\\Reflection\\Php\\File <phpDocumentor\\Reflection\\Php\\File>`)


:Returns: array



.. rst-class:: private

.. php:method:: private parseTraits( $file)
:Source:
`/ApiDocBuilder.php#332 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L332>`_


:Parameters:
* **$file** (:any:`phpDocumentor\\Reflection\\Php\\File <phpDocumentor\\Reflection\\Php\\File>`)
Expand All @@ -278,19 +379,24 @@ Methods

.. php:method:: private parseFunctions( $file)
:Source:
`/ApiDocBuilder.php#352 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L352>`_


:Parameters:
* **$file** (:any:`phpDocumentor\\Reflection\\Php\\File <phpDocumentor\\Reflection\\Php\\File>`)


:Returns: bool | string



.. rst-class:: private

.. php:method:: private parseConstants( $file)
:Source:
`/ApiDocBuilder.php#368 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//ApiDocBuilder.php#L368>`_


:Parameters:
* **$file** (:any:`phpDocumentor\\Reflection\\Php\\File <phpDocumentor\\Reflection\\Php\\File>`)
Expand Down
20 changes: 20 additions & 0 deletions docs/api/JuliusHaertl/PHPDocToRst/Builder/ClassFileBuilder.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,34 @@ ClassFileBuilder
.. php:class:: ClassFileBuilder
:Source:
`/Builder/ClassFileBuilder.php#26 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/ClassFileBuilder.php#L26>`_

:Parent:
:php:class:`JuliusHaertl\\PHPDocToRst\\Builder\\FileBuilder`



Summary
-------

Methods
~~~~~~~

* :php:meth:`protected render\(\)<JuliusHaertl\\PHPDocToRst\\Builder\\ClassFileBuilder::render\(\)>`
* :php:meth:`protected addImplementedInterfaces\($element\)<JuliusHaertl\\PHPDocToRst\\Builder\\ClassFileBuilder::addImplementedInterfaces\(\)>`


Methods
-------

.. rst-class:: protected

.. php:method:: protected render()
:Source:
`/Builder/ClassFileBuilder.php#28 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/ClassFileBuilder.php#L28>`_




Expand All @@ -32,6 +49,9 @@ Methods

.. php:method:: protected addImplementedInterfaces( $element)
:Source:
`/Builder/ClassFileBuilder.php#57 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/ClassFileBuilder.php#L57>`_


:Parameters:
* **$element** (:any:`phpDocumentor\\Reflection\\Php\\Class\_ <phpDocumentor\\Reflection\\Php\\Class\_>`)
Expand Down
Loading

0 comments on commit 62ff8d6

Please sign in to comment.