diff --git a/README.md b/README.md index 8063ac6..d50f046 100755 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/api/JuliusHaertl/PHPDocToRst/ApiDocBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/ApiDocBuilder.rst index bcd8a99..78bf5a1 100644 --- a/docs/api/JuliusHaertl/PHPDocToRst/ApiDocBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/ApiDocBuilder.rst @@ -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 `_ + + + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public \_\_construct\($srcDir, $dstDir\)` +* :php:meth:`public build\(\)` +* :php:meth:`private setupReflection\(\)` +* :php:meth:`public log\($message\)` +* :php:meth:`private createDirectoryStructure\(\)` +* :php:meth:`private parseFiles\(\)` +* :php:meth:`public debug\($message\)` +* :php:meth:`private buildIndexes\(\)` +* :php:meth:`public setVerboseOutput\($v\)` +* :php:meth:`public setDebugOutput\($v\)` +* :php:meth:`public addExtension\($class, $arguments\)` +* :php:meth:`private parseInterfaces\($file\)` +* :php:meth:`private parseClasses\($file\)` +* :php:meth:`private parseTraits\($file\)` +* :php:meth:`private parseFunctions\($file\)` +* :php:meth:`private parseConstants\($file\)` + Properties ---------- .. php:attr:: private static project + :Source: + `/ApiDocBuilder.php#52 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Php\\Project ` .. php:attr:: private static docFiles + :Source: + `/ApiDocBuilder.php#55 `_ + :Type: array .. php:attr:: private static constants + :Source: + `/ApiDocBuilder.php#58 `_ + :Type: array .. php:attr:: private static functions + :Source: + `/ApiDocBuilder.php#61 `_ + :Type: array .. php:attr:: private static extensions + :Source: + `/ApiDocBuilder.php#64 `_ + :Type: :any:`\\JuliusHaertl\\PHPDocToRst\\Extension\\Extension\[\] ` .. php:attr:: private static extensionNames + :Source: + `/ApiDocBuilder.php#67 `_ + :Type: string[] .. php:attr:: private static extensionArguments + :Source: + `/ApiDocBuilder.php#70 `_ + :Type: array[] .. php:attr:: private static srcDir + :Source: + `/ApiDocBuilder.php#73 `_ + :Type: string[] .. php:attr:: private static dstDir + :Source: + `/ApiDocBuilder.php#76 `_ + :Type: string .. php:attr:: private static verboseOutput + :Source: + `/ApiDocBuilder.php#79 `_ + :Type: bool .. php:attr:: private static debugOutput + :Source: + `/ApiDocBuilder.php#82 `_ + :Type: bool @@ -94,6 +155,9 @@ Methods | ApiDocBuilder constructor\. + :Source: + `/ApiDocBuilder.php#90 `_ + :Parameters: * **$srcDir** (string[]) array of paths that should be analysed @@ -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 `_ + @@ -120,6 +187,9 @@ Methods .. php:method:: private setupReflection() + :Source: + `/ApiDocBuilder.php#112 `_ + :Throws: :any:`\\Exception ` @@ -131,9 +201,12 @@ Methods .. rst-class:: phpdoc-description - | Log a message + | Log a message\. + :Source: + `/ApiDocBuilder.php#166 `_ + :Parameters: * **$message** (string) Message to be logged @@ -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 `_ + :Throws: :any:`\\JuliusHaertl\\PHPDocToRst\\WriteException ` @@ -160,6 +236,9 @@ Methods .. php:method:: private parseFiles() + :Source: + `/ApiDocBuilder.php#191 `_ + @@ -170,9 +249,12 @@ Methods .. rst-class:: phpdoc-description - | Log a debug message + | Log a debug message\. + :Source: + `/ApiDocBuilder.php#218 `_ + :Parameters: * **$message** (string) Message to be logged @@ -185,6 +267,9 @@ Methods .. php:method:: private buildIndexes() + :Source: + `/ApiDocBuilder.php#225 `_ + @@ -195,9 +280,12 @@ Methods .. rst-class:: phpdoc-description - | Enable verbose logging output + | Enable verbose logging output\. + :Source: + `/ApiDocBuilder.php#263 `_ + :Parameters: * **$v** (bool) Set to true to enable @@ -212,9 +300,12 @@ Methods .. rst-class:: phpdoc-description - | Enable debug logging output + | Enable debug logging output\. + :Source: + `/ApiDocBuilder.php#273 `_ + :Parameters: * **$v** (bool) Set to true to enable @@ -227,6 +318,9 @@ Methods .. php:method:: public addExtension( $class, $arguments=\[\]) + :Source: + `/ApiDocBuilder.php#283 `_ + :Parameters: * **$class** (string) name of the extension class @@ -240,12 +334,14 @@ Methods .. php:method:: private parseInterfaces( $file) + :Source: + `/ApiDocBuilder.php#292 `_ + :Parameters: * **$file** (:any:`phpDocumentor\\Reflection\\Php\\File `) - :Returns: array @@ -253,12 +349,14 @@ Methods .. php:method:: private parseClasses( $file) + :Source: + `/ApiDocBuilder.php#312 `_ + :Parameters: * **$file** (:any:`phpDocumentor\\Reflection\\Php\\File `) - :Returns: array @@ -266,6 +364,9 @@ Methods .. php:method:: private parseTraits( $file) + :Source: + `/ApiDocBuilder.php#332 `_ + :Parameters: * **$file** (:any:`phpDocumentor\\Reflection\\Php\\File `) @@ -278,12 +379,14 @@ Methods .. php:method:: private parseFunctions( $file) + :Source: + `/ApiDocBuilder.php#352 `_ + :Parameters: * **$file** (:any:`phpDocumentor\\Reflection\\Php\\File `) - :Returns: bool | string @@ -291,6 +394,9 @@ Methods .. php:method:: private parseConstants( $file) + :Source: + `/ApiDocBuilder.php#368 `_ + :Parameters: * **$file** (:any:`phpDocumentor\\Reflection\\Php\\File `) diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Builder/ClassFileBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/Builder/ClassFileBuilder.rst index 5f6298f..78e98be 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Builder/ClassFileBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Builder/ClassFileBuilder.rst @@ -13,10 +13,24 @@ ClassFileBuilder .. php:class:: ClassFileBuilder + :Source: + `/Builder/ClassFileBuilder.php#26 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Builder\\FileBuilder` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`protected render\(\)` +* :php:meth:`protected addImplementedInterfaces\($element\)` + + Methods ------- @@ -24,6 +38,9 @@ Methods .. php:method:: protected render() + :Source: + `/Builder/ClassFileBuilder.php#28 `_ + @@ -32,6 +49,9 @@ Methods .. php:method:: protected addImplementedInterfaces( $element) + :Source: + `/Builder/ClassFileBuilder.php#57 `_ + :Parameters: * **$element** (:any:`phpDocumentor\\Reflection\\Php\\Class\_ `) diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Builder/ExtensionBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/Builder/ExtensionBuilder.rst index aaaac11..13b026a 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Builder/ExtensionBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Builder/ExtensionBuilder.rst @@ -13,12 +13,18 @@ ExtensionBuilder .. php:trait:: ExtensionBuilder + :Source: + `/Builder/ExtensionBuilder.php#13 `_ + Properties ---------- .. php:attr:: protected static extensions + :Source: + `/Builder/ExtensionBuilder.php#16 `_ + :Type: :any:`\\JuliusHaertl\\PHPDocToRst\\Extension\\Extension\[\] ` @@ -29,6 +35,9 @@ Methods .. php:method:: public __construct( $extensions) + :Source: + `/Builder/ExtensionBuilder.php#18 `_ + @@ -37,6 +46,9 @@ Methods .. php:method:: protected callExtensions( $type, $element) + :Source: + `/Builder/ExtensionBuilder.php#23 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Builder/FileBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/Builder/FileBuilder.rst index 0309937..d7205e9 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Builder/FileBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Builder/FileBuilder.rst @@ -17,28 +17,53 @@ FileBuilder .. rst-class:: phpdoc-description - | Abstract building class to build sphinxcontrib\-phpdomain from a php file + | Abstract building class to build sphinxcontrib\-phpdomain from a php file\. + :Source: + `/Builder/FileBuilder.php#30 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Builder\\PhpDomainBuilder` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public \_\_construct\($file, $element, $extensions\)` +* :php:meth:`protected abstract render\(\)` +* :php:meth:`public getElement\(\)` +* :php:meth:`public getFile\(\)` + + Properties ---------- .. php:attr:: protected static file + :Source: + `/Builder/FileBuilder.php#33 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Php\\File ` .. php:attr:: protected static element + :Source: + `/Builder/FileBuilder.php#36 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Element ` .. php:attr:: protected static extensions + :Source: + `/Builder/FileBuilder.php#39 `_ + :Type: :any:`\\JuliusHaertl\\PHPDocToRst\\Extension\\Extension\[\] ` @@ -49,6 +74,9 @@ Methods .. php:method:: public __construct( $file, $element, $extensions) + :Source: + `/Builder/FileBuilder.php#41 `_ + @@ -57,6 +85,9 @@ Methods .. php:method:: protected abstract render() + :Source: + `/Builder/FileBuilder.php#49 `_ + @@ -65,6 +96,9 @@ Methods .. php:method:: public getElement() + :Source: + `/Builder/FileBuilder.php#54 `_ + :Returns: :any:`\\phpDocumentor\\Reflection\\Element ` that is used to build the rst file @@ -74,6 +108,9 @@ Methods .. php:method:: public getFile() + :Source: + `/Builder/FileBuilder.php#62 `_ + :Returns: :any:`\\phpDocumentor\\Reflection\\Php\\File ` diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Builder/InterfaceFileBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/Builder/InterfaceFileBuilder.rst index 8fda206..ffa84c8 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Builder/InterfaceFileBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Builder/InterfaceFileBuilder.rst @@ -13,10 +13,23 @@ InterfaceFileBuilder .. php:class:: InterfaceFileBuilder + :Source: + `/Builder/InterfaceFileBuilder.php#25 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Builder\\FileBuilder` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`protected render\(\)` + + Methods ------- @@ -24,6 +37,9 @@ Methods .. php:method:: protected render() + :Source: + `/Builder/InterfaceFileBuilder.php#27 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Builder/MainIndexBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/Builder/MainIndexBuilder.rst index 06e6760..fca92ea 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Builder/MainIndexBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Builder/MainIndexBuilder.rst @@ -18,15 +18,32 @@ MainIndexBuilder | This class builds a list of all available namespaces in the project\. + :Source: + `/Builder/MainIndexBuilder.php#28 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Builder\\RstBuilder` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public \_\_construct\($namespaces\)` +* :php:meth:`public render\(\)` + + Properties ---------- .. php:attr:: private static namespaces + :Source: + `/Builder/MainIndexBuilder.php#31 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Php\\Namespace\_\[\] ` @@ -37,6 +54,9 @@ Methods .. php:method:: public __construct( $namespaces) + :Source: + `/Builder/MainIndexBuilder.php#33 `_ + @@ -45,6 +65,9 @@ Methods .. php:method:: public render() + :Source: + `/Builder/MainIndexBuilder.php#38 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Builder/NamespaceIndexBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/Builder/NamespaceIndexBuilder.rst index 639e764..88497a0 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Builder/NamespaceIndexBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Builder/NamespaceIndexBuilder.rst @@ -17,38 +17,77 @@ NamespaceIndexBuilder | This class will build an index for each namespace\. - | It contains a toc for child namespaces, classes, traits, interfaces and functions + | It contains a toc for child namespaces, classes, traits, interfaces and functions\. + :Source: + `/Builder/NamespaceIndexBuilder.php#34 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Builder\\PhpDomainBuilder` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public \_\_construct\($extensions, $namespaces, $current, $functions, $constants\)` +* :php:meth:`private findChildNamespaces\(\)` +* :php:meth:`public render\(\)` +* :php:meth:`protected addIndex\($type\)` +* :php:meth:`private shouldRenderIndex\($type, $element\)` +* :php:meth:`private getElementList\($type\)` +* :php:meth:`private getHeaderForType\($type\)` +* :php:meth:`private addElementTocEntry\($entry\)` +* :php:meth:`private addFunctions\(\)` + + Constants --------- .. php:const:: RENDER_INDEX_NAMESPACE = 0 + :Source: + `/Builder/NamespaceIndexBuilder.php#36 `_ + .. php:const:: RENDER_INDEX_CLASSES = 1 + :Source: + `/Builder/NamespaceIndexBuilder.php#37 `_ + .. php:const:: RENDER_INDEX_TRAITS = 2 + :Source: + `/Builder/NamespaceIndexBuilder.php#38 `_ + .. php:const:: RENDER_INDEX_INTERFACES = 3 + :Source: + `/Builder/NamespaceIndexBuilder.php#39 `_ + .. php:const:: RENDER_INDEX_FUNCTIONS = 4 + :Source: + `/Builder/NamespaceIndexBuilder.php#40 `_ + .. php:const:: RENDER_INDEX_CONSTANTS = 5 + :Source: + `/Builder/NamespaceIndexBuilder.php#41 `_ + Properties @@ -56,26 +95,41 @@ Properties .. php:attr:: private static currentNamespace + :Source: + `/Builder/NamespaceIndexBuilder.php#44 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Php\\Namespace\_ ` .. php:attr:: private static namespaces + :Source: + `/Builder/NamespaceIndexBuilder.php#47 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Php\\Namespace\_\[\] ` .. php:attr:: private static childNamespaces + :Source: + `/Builder/NamespaceIndexBuilder.php#50 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Php\\Namespace\_\[\] ` .. php:attr:: private static functions + :Source: + `/Builder/NamespaceIndexBuilder.php#53 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Php\\Function\_\[\] ` .. php:attr:: private static constants + :Source: + `/Builder/NamespaceIndexBuilder.php#56 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Php\\Constant\[\] ` @@ -86,6 +140,9 @@ Methods .. php:method:: public __construct( $extensions, $namespaces, $current, $functions, $constants) + :Source: + `/Builder/NamespaceIndexBuilder.php#58 `_ + @@ -96,9 +153,12 @@ Methods .. rst-class:: phpdoc-description - | Find child namespaces for current namespace + | Find child namespaces for current namespace\. + :Source: + `/Builder/NamespaceIndexBuilder.php#71 `_ + @@ -107,6 +167,9 @@ Methods .. php:method:: public render() + :Source: + `/Builder/NamespaceIndexBuilder.php#93 `_ + @@ -115,14 +178,20 @@ Methods .. php:method:: protected addIndex( $type) + :Source: + `/Builder/NamespaceIndexBuilder.php#119 `_ + .. rst-class:: private - .. php:method:: private shouldRenderIndex( $type, $element=NULL) + .. php:method:: private shouldRenderIndex( $type, $element=null) + :Source: + `/Builder/NamespaceIndexBuilder.php#142 `_ + @@ -131,6 +200,9 @@ Methods .. php:method:: private getElementList( $type) + :Source: + `/Builder/NamespaceIndexBuilder.php#161 `_ + :Parameters: * **$type** (int) @@ -144,6 +216,9 @@ Methods .. php:method:: private getHeaderForType( $type) + :Source: + `/Builder/NamespaceIndexBuilder.php#188 `_ + @@ -152,6 +227,9 @@ Methods .. php:method:: private addElementTocEntry( $entry) + :Source: + `/Builder/NamespaceIndexBuilder.php#201 `_ + @@ -160,6 +238,9 @@ Methods .. php:method:: private addFunctions() + :Source: + `/Builder/NamespaceIndexBuilder.php#213 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Builder/PhpDomainBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/Builder/PhpDomainBuilder.rst index f3da230..70430f9 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Builder/PhpDomainBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Builder/PhpDomainBuilder.rst @@ -15,9 +15,12 @@ PhpDomainBuilder .. rst-class:: phpdoc-description - | Class to build reStructuredText file with sphinxcontrib\-phpdomain syntax + | Class to build reStructuredText file with sphinxcontrib\-phpdomain syntax\. + :Source: + `/Builder/PhpDomainBuilder.php#44 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Builder\\RstBuilder` @@ -25,23 +28,67 @@ PhpDomainBuilder :php:trait:`JuliusHaertl\\PHPDocToRst\\Builder\\ExtensionBuilder` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public \_\_construct\($extensions\)` +* :php:meth:`protected addPageHeader\($element\)` +* :php:meth:`public static getNamespace\($element\)` +* :php:meth:`public beginPhpDomain\($type, $name, $indent\)` +* :php:meth:`private getTypeForClass\($element\)` +* :php:meth:`protected addAfterIntroduction\($element\)` +* :php:meth:`protected addConstants\($constants\)` +* :php:meth:`public shouldRenderElement\($element\)` +* :php:meth:`private addConstant\($constant\)` +* :php:meth:`public addDocBlockDescription\($element\)` +* :php:meth:`protected addDocblockTag\($tagName, $docBlock\)` +* :php:meth:`public static typesToRst\($typesString\)` +* :php:meth:`public endPhpDomain\($type\)` +* :php:meth:`protected addProperties\($properties\)` +* :php:meth:`private addProperty\($property\)` +* :php:meth:`protected addParent\($element\)` +* :php:meth:`public static getLink\($type, $fqsen, $description\)` +* :php:meth:`protected addUsedTraits\($element\)` +* :php:meth:`protected addMethods\($methods\)` +* :php:meth:`private addMethod\($method\)` +* :php:meth:`private processMethodArgumentDocs\($method, $params\)` +* :php:meth:`private processMethodArgumentTypes\($method\)` +* :php:meth:`private processMethodArgumentType\($argument, $args\)` + + Constants --------- .. php:const:: SECTION_BEFORE_DESCRIPTION = self::class \. ::SECTION\_BEFORE\_DESCRIPTION + :Source: + `/Builder/PhpDomainBuilder.php#46 `_ + .. php:const:: SECTION_AFTER_DESCRIPTION = self::class \. ::SECTION\_AFTER\_DESCRIPTION + :Source: + `/Builder/PhpDomainBuilder.php#47 `_ + .. php:const:: SECTION_AFTER_TITLE = self::class \. ::SECTION\_AFTER\_TITLE + :Source: + `/Builder/PhpDomainBuilder.php#48 `_ + .. php:const:: SECTION_AFTER_INTRODUCTION = self::class \. ::SECTION\_AFTER\_INTRODUCTION + :Source: + `/Builder/PhpDomainBuilder.php#49 `_ + Methods @@ -51,6 +98,9 @@ Methods .. php:method:: public __construct( $extensions) + :Source: + `/Builder/PhpDomainBuilder.php#55 `_ + @@ -61,9 +111,12 @@ Methods .. rst-class:: phpdoc-description - | Add namespace + | Add namespace\. + :Source: + `/Builder/PhpDomainBuilder.php#67 `_ + :Parameters: * **$element** (:any:`phpDocumentor\\Reflection\\Element `) @@ -78,9 +131,12 @@ Methods .. rst-class:: phpdoc-description - | Strip element name from Fqsen to return the namespace only + | Strip element name from Fqsen to return the namespace only\. + :Source: + `/Builder/PhpDomainBuilder.php#94 `_ + :Parameters: * **$element** (:any:`phpDocumentor\\Reflection\\Element `) @@ -94,6 +150,9 @@ Methods .. php:method:: public beginPhpDomain( $type, $name, $indent=true) + :Source: + `/Builder/PhpDomainBuilder.php#105 `_ + :Parameters: * **$type** string @@ -108,6 +167,9 @@ Methods .. php:method:: private getTypeForClass( $element) + :Source: + `/Builder/PhpDomainBuilder.php#114 `_ + @@ -116,6 +178,9 @@ Methods .. php:method:: protected addAfterIntroduction( $element) + :Source: + `/Builder/PhpDomainBuilder.php#132 `_ + @@ -124,6 +189,9 @@ Methods .. php:method:: protected addConstants( $constants) + :Source: + `/Builder/PhpDomainBuilder.php#137 `_ + @@ -132,6 +200,9 @@ Methods .. php:method:: public shouldRenderElement( $element) + :Source: + `/Builder/PhpDomainBuilder.php#154 `_ + :Parameters: * **$element** (:any:`phpDocumentor\\Reflection\\Element `) @@ -145,6 +216,9 @@ Methods .. php:method:: private addConstant( $constant) + :Source: + `/Builder/PhpDomainBuilder.php#169 `_ + :Parameters: * **$constant** (:any:`phpDocumentor\\Reflection\\Php\\Constant `) @@ -157,6 +231,9 @@ Methods .. php:method:: public addDocBlockDescription( $element) + :Source: + `/Builder/PhpDomainBuilder.php#187 `_ + :Parameters: * **$element** (:any:`phpDocumentor\\Reflection\\Php\\Class\_ ` | :any:`\\phpDocumentor\\Reflection\\Php\\Interface\_ ` | :any:`\\phpDocumentor\\Reflection\\Php\\Trait\_ ` | :any:`\\phpDocumentor\\Reflection\\Php\\Property ` | :any:`\\phpDocumentor\\Reflection\\Php\\Method ` | :any:`\\phpDocumentor\\Reflection\\Php\\Constant `) @@ -170,6 +247,9 @@ Methods .. php:method:: protected addDocblockTag( $tagName, $docBlock) + :Source: + `/Builder/PhpDomainBuilder.php#212 `_ + :Parameters: * **$tagName** (string) Name of the tag to parse @@ -183,6 +263,9 @@ Methods .. php:method:: public static typesToRst( $typesString) + :Source: + `/Builder/PhpDomainBuilder.php#281 `_ + :Parameters: * **$typesString** (string) @@ -196,6 +279,9 @@ Methods .. php:method:: public endPhpDomain( $type="") + :Source: + `/Builder/PhpDomainBuilder.php#327 `_ + :Parameters: * **$type** (string) @@ -209,6 +295,9 @@ Methods .. php:method:: protected addProperties( $properties) + :Source: + `/Builder/PhpDomainBuilder.php#336 `_ + :Parameters: * **$properties** (:any:`phpDocumentor\\Reflection\\Php\\Property\[\] `) @@ -221,6 +310,9 @@ Methods .. php:method:: private addProperty( $property) + :Source: + `/Builder/PhpDomainBuilder.php#351 `_ + :Parameters: * **$property** (:any:`phpDocumentor\\Reflection\\Php\\Property `) @@ -233,6 +325,9 @@ Methods .. php:method:: protected addParent( $element) + :Source: + `/Builder/PhpDomainBuilder.php#368 `_ + :Parameters: * **$element** (:any:`phpDocumentor\\Reflection\\Php\\Interface\_ ` | :any:`\\phpDocumentor\\Reflection\\Php\\Class\_ `) @@ -245,6 +340,9 @@ Methods .. php:method:: public static getLink( $type, $fqsen, $description="") + :Source: + `/Builder/PhpDomainBuilder.php#390 `_ + :Parameters: * **$type** string @@ -259,6 +357,9 @@ Methods .. php:method:: protected addUsedTraits( $element) + :Source: + `/Builder/PhpDomainBuilder.php#403 `_ + :Parameters: * **$element** (:any:`phpDocumentor\\Reflection\\Php\\Class\_ ` | :any:`\\phpDocumentor\\Reflection\\Php\\Trait\_ `) @@ -271,6 +372,9 @@ Methods .. php:method:: protected addMethods( $methods) + :Source: + `/Builder/PhpDomainBuilder.php#417 `_ + :Parameters: * **$methods** @@ -283,6 +387,9 @@ Methods .. php:method:: private addMethod( $method) + :Source: + `/Builder/PhpDomainBuilder.php#427 `_ + @@ -291,6 +398,9 @@ Methods .. php:method:: private processMethodArgumentDocs( $method, $params) + :Source: + `/Builder/PhpDomainBuilder.php#474 `_ + :Parameters: * **$method** (:any:`phpDocumentor\\Reflection\\Php\\Method `) @@ -305,6 +415,9 @@ Methods .. php:method:: private processMethodArgumentTypes( $method) + :Source: + `/Builder/PhpDomainBuilder.php#511 `_ + :Parameters: * **$method** (:any:`phpDocumentor\\Reflection\\Php\\Method `) @@ -318,6 +431,9 @@ Methods .. php:method:: private processMethodArgumentType( $argument, $args) + :Source: + `/Builder/PhpDomainBuilder.php#527 `_ + :Parameters: * **$argument** (:any:`phpDocumentor\\Reflection\\Php\\Argument `) diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Builder/RstBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/Builder/RstBuilder.rst index fb4ac60..d2a060d 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Builder/RstBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Builder/RstBuilder.rst @@ -15,20 +15,50 @@ RstBuilder .. rst-class:: phpdoc-description - | Helper class to build reStructuredText files + | Helper class to build reStructuredText files\. + :Source: + `/Builder/RstBuilder.php#26 `_ + + + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public getContent\(\)` +* :php:meth:`public addFieldList\($key, $value\)` +* :php:meth:`public addLine\($text\)` +* :php:meth:`public add\($text\)` +* :php:meth:`public static escape\($text\)` +* :php:meth:`public unindent\(\)` +* :php:meth:`public addMultiline\($text, $blockIndent\)` +* :php:meth:`public indent\(\)` +* :php:meth:`public addH1\($text\)` +* :php:meth:`public addH2\($text\)` +* :php:meth:`public addH3\($text\)` +* :php:meth:`public addMultilineWithoutRendering\($text\)` + Properties ---------- .. php:attr:: protected static content + :Source: + `/Builder/RstBuilder.php#29 `_ + :Type: string .. php:attr:: private static indentLevel + :Source: + `/Builder/RstBuilder.php#30 `_ + Methods @@ -38,6 +68,9 @@ Methods .. php:method:: public getContent() + :Source: + `/Builder/RstBuilder.php#32 `_ + @@ -46,6 +79,9 @@ Methods .. php:method:: public addFieldList( $key, $value) + :Source: + `/Builder/RstBuilder.php#37 `_ + @@ -54,6 +90,9 @@ Methods .. php:method:: public addLine( $text="") + :Source: + `/Builder/RstBuilder.php#45 `_ + @@ -62,6 +101,9 @@ Methods .. php:method:: public add( $text) + :Source: + `/Builder/RstBuilder.php#52 `_ + @@ -70,6 +112,9 @@ Methods .. php:method:: public static escape( $text) + :Source: + `/Builder/RstBuilder.php#59 `_ + @@ -78,6 +123,9 @@ Methods .. php:method:: public unindent() + :Source: + `/Builder/RstBuilder.php#67 `_ + @@ -86,6 +134,9 @@ Methods .. php:method:: public addMultiline( $text="", $blockIndent=false) + :Source: + `/Builder/RstBuilder.php#75 `_ + @@ -94,6 +145,9 @@ Methods .. php:method:: public indent() + :Source: + `/Builder/RstBuilder.php#92 `_ + @@ -102,6 +156,9 @@ Methods .. php:method:: public addH1( $text) + :Source: + `/Builder/RstBuilder.php#104 `_ + :Parameters: * **$text** (string) @@ -115,6 +172,9 @@ Methods .. php:method:: public addH2( $text) + :Source: + `/Builder/RstBuilder.php#112 `_ + @@ -123,6 +183,9 @@ Methods .. php:method:: public addH3( $text) + :Source: + `/Builder/RstBuilder.php#120 `_ + @@ -131,6 +194,9 @@ Methods .. php:method:: public addMultilineWithoutRendering( $text) + :Source: + `/Builder/RstBuilder.php#128 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Builder/TraitFileBuilder.rst b/docs/api/JuliusHaertl/PHPDocToRst/Builder/TraitFileBuilder.rst index f1e5928..3509624 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Builder/TraitFileBuilder.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Builder/TraitFileBuilder.rst @@ -13,10 +13,23 @@ TraitFileBuilder .. php:class:: TraitFileBuilder + :Source: + `/Builder/TraitFileBuilder.php#25 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Builder\\FileBuilder` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`protected render\(\)` + + Methods ------- @@ -24,6 +37,9 @@ Methods .. php:method:: protected render() + :Source: + `/Builder/TraitFileBuilder.php#27 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Extension/AddFullElementNameExtension.rst b/docs/api/JuliusHaertl/PHPDocToRst/Extension/AddFullElementNameExtension.rst index 7843b97..194b7c4 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Extension/AddFullElementNameExtension.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Extension/AddFullElementNameExtension.rst @@ -15,13 +15,26 @@ AddFullElementNameExtension .. rst-class:: phpdoc-description - | Add the fully qualified element name including the namespace to each page + | Add the fully qualified element name including the namespace to each page\. + :Source: + `/Extension/AddFullElementNameExtension.php#31 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Extension\\Extension` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public render\($type, $builder, $element\)` + + Methods ------- @@ -29,6 +42,9 @@ Methods .. php:method:: public render( $type, &$builder, $element) + :Source: + `/Extension/AddFullElementNameExtension.php#37 `_ + :Parameters: * **$type** (string) diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Extension/Extension.rst b/docs/api/JuliusHaertl/PHPDocToRst/Extension/Extension.rst index 749933c..56b9ad9 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Extension/Extension.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Extension/Extension.rst @@ -15,17 +15,40 @@ Extension .. php:class:: Extension + :Source: + `/Extension/Extension.php#27 `_ + + + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public \_\_construct\($project, $arguments\)` +* :php:meth:`public prepare\(\)` +* :php:meth:`public render\($type, $builder, $element\)` +* :php:meth:`public shouldRenderElement\($element\)` +* :php:meth:`public shouldRenderIndex\($type, $element\)` + Properties ---------- .. php:attr:: protected static project + :Source: + `/Extension/Extension.php#30 `_ + :Type: :any:`\\phpDocumentor\\Reflection\\Php\\Project ` .. php:attr:: protected static arguments + :Source: + `/Extension/Extension.php#33 `_ + :Type: array @@ -36,6 +59,9 @@ Methods .. php:method:: public __construct( $project, $arguments=\[\]) + :Source: + `/Extension/Extension.php#35 `_ + @@ -48,9 +74,12 @@ Methods | Method that will be ran before generating any documentation files | This is useful for preparing own data structures - | to be used in the output documentation + | to be used in the output documentation\. + :Source: + `/Extension/Extension.php#46 `_ + @@ -71,6 +100,9 @@ Methods | \- PhpDomainBuilder::SECTION\_AFTER\_DESCRIPTION + :Source: + `/Extension/Extension.php#63 `_ + :Parameters: * **$type** (string) @@ -93,6 +125,9 @@ Methods | An example extension that makes use of it is PublicOnlyExtension + :Source: + `/Extension/Extension.php#77 `_ + :Parameters: * **$element** (:any:`phpDocumentor\\Reflection\\Element `) @@ -106,6 +141,9 @@ Methods .. php:method:: public shouldRenderIndex( $type, $element) + :Source: + `/Extension/Extension.php#82 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Extension/GithubLocationExtension.rst b/docs/api/JuliusHaertl/PHPDocToRst/Extension/GithubLocationExtension.rst index 7a87cac..8b82cd7 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Extension/GithubLocationExtension.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Extension/GithubLocationExtension.rst @@ -15,7 +15,7 @@ GithubLocationExtension .. rst-class:: phpdoc-description - | This extension adds a link to the source at github to all elements + | This extension adds a link to the source at github to all elements\. | Arguments | 0 =\> Url to the github repo \(required\) @@ -23,23 +23,47 @@ GithubLocationExtension | 2 =\> Branch to link to \(default=master\) + :Source: + `/Extension/GithubLocationExtension.php#37 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Extension\\Extension` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public prepare\(\)` +* :php:meth:`public render\($type, $builder, $element\)` +* :php:meth:`private getGithubLink\($file, $line, $branch\)` + + Properties ---------- .. php:attr:: protected static basePath + :Source: + `/Extension/GithubLocationExtension.php#39 `_ + .. php:attr:: protected static githubRepo + :Source: + `/Extension/GithubLocationExtension.php#40 `_ + .. php:attr:: protected static branch + :Source: + `/Extension/GithubLocationExtension.php#41 `_ + Methods @@ -49,6 +73,9 @@ Methods .. php:method:: public prepare() + :Source: + `/Extension/GithubLocationExtension.php#43 `_ + @@ -57,6 +84,9 @@ Methods .. php:method:: public render( $type, &$builder, $element) + :Source: + `/Extension/GithubLocationExtension.php#60 `_ + :Parameters: * **$type** (string) @@ -71,6 +101,9 @@ Methods .. php:method:: private getGithubLink( $file, $line=1, $branch=master) + :Source: + `/Extension/GithubLocationExtension.php#77 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Extension/HideChildNamespaces.rst b/docs/api/JuliusHaertl/PHPDocToRst/Extension/HideChildNamespaces.rst index c1041be..b27defb 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Extension/HideChildNamespaces.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Extension/HideChildNamespaces.rst @@ -15,13 +15,26 @@ HideChildNamespaces .. rst-class:: phpdoc-description - | Example for hiding a section in the namespace index page + | Example for hiding a section in the namespace index page\. + :Source: + `/Extension/HideChildNamespaces.php#28 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Extension\\Extension` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public shouldRenderIndex\($type, $element\)` + + Methods ------- @@ -29,6 +42,9 @@ Methods .. php:method:: public shouldRenderIndex( $type, $element) + :Source: + `/Extension/HideChildNamespaces.php#30 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Extension/InterfaceImplementors.rst b/docs/api/JuliusHaertl/PHPDocToRst/Extension/InterfaceImplementors.rst index 48f5de3..cf12051 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Extension/InterfaceImplementors.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Extension/InterfaceImplementors.rst @@ -15,18 +15,35 @@ InterfaceImplementors .. rst-class:: phpdoc-description - | Class InterfaceImplementors + | Class InterfaceImplementors\. + :Source: + `/Extension/InterfaceImplementors.php#32 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Extension\\Extension` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public prepare\(\)` +* :php:meth:`public render\($type, $builder, $element\)` + + Properties ---------- .. php:attr:: private static implementors + :Source: + `/Extension/InterfaceImplementors.php#34 `_ + Methods @@ -36,6 +53,9 @@ Methods .. php:method:: public prepare() + :Source: + `/Extension/InterfaceImplementors.php#36 `_ + @@ -44,6 +64,9 @@ Methods .. php:method:: public render( $type, &$builder, $element) + :Source: + `/Extension/InterfaceImplementors.php#55 `_ + :Parameters: * **$type** (string) diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Extension/NoPrivateExtension.rst b/docs/api/JuliusHaertl/PHPDocToRst/Extension/NoPrivateExtension.rst index 094df97..0661e48 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Extension/NoPrivateExtension.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Extension/NoPrivateExtension.rst @@ -16,13 +16,26 @@ NoPrivateExtension .. rst-class:: phpdoc-description | Do not render classes marked with phpDoc internal tag - | Do only render public methods/properties + | Do only render public methods/properties\. + :Source: + `/Extension/NoPrivateExtension.php#32 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Extension\\Extension` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public shouldRenderElement\($element\)` + + Methods ------- @@ -30,6 +43,9 @@ Methods .. php:method:: public shouldRenderElement( $element) + :Source: + `/Extension/NoPrivateExtension.php#34 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Extension/PublicOnlyExtension.rst b/docs/api/JuliusHaertl/PHPDocToRst/Extension/PublicOnlyExtension.rst index 6b898b7..4ab8029 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Extension/PublicOnlyExtension.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Extension/PublicOnlyExtension.rst @@ -16,13 +16,26 @@ PublicOnlyExtension .. rst-class:: phpdoc-description | Do not render classes marked with phpDoc internal tag - | Do only render public methods/properties + | Do only render public methods/properties\. + :Source: + `/Extension/PublicOnlyExtension.php#32 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Extension\\Extension` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public shouldRenderElement\($element\)` + + Methods ------- @@ -30,6 +43,9 @@ Methods .. php:method:: public shouldRenderElement( $element) + :Source: + `/Extension/PublicOnlyExtension.php#34 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Extension/TocExtension.rst b/docs/api/JuliusHaertl/PHPDocToRst/Extension/TocExtension.rst index 358b105..4c5e28a 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Extension/TocExtension.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Extension/TocExtension.rst @@ -16,13 +16,26 @@ TocExtension .. rst-class:: phpdoc-description | This extension will render a list of methods for easy access - | at the beginning of classes, interfaces and traits + | at the beginning of classes, interfaces and traits\. + :Source: + `/Extension/TocExtension.php#34 `_ + :Parent: :php:class:`JuliusHaertl\\PHPDocToRst\\Extension\\Extension` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public render\($type, $builder, $element\)` + + Methods ------- @@ -30,6 +43,9 @@ Methods .. php:method:: public render( $type, &$builder, $element) + :Source: + `/Extension/TocExtension.php#40 `_ + :Parameters: * **$type** (string) diff --git a/docs/api/JuliusHaertl/PHPDocToRst/GenerateDocumentationCommand.rst b/docs/api/JuliusHaertl/PHPDocToRst/GenerateDocumentationCommand.rst index f7b8724..2561d07 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/GenerateDocumentationCommand.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/GenerateDocumentationCommand.rst @@ -15,13 +15,27 @@ GenerateDocumentationCommand .. rst-class:: phpdoc-description - | Class GenerateDocumentationCommand + | Class GenerateDocumentationCommand\. + :Source: + `/GenerateDocumentationCommand.php#38 `_ + :Parent: :php:class:`Symfony\\Component\\Console\\Command\\Command` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`protected configure\(\)` +* :php:meth:`protected execute\($input, $output\)` + + Methods ------- @@ -29,6 +43,9 @@ Methods .. php:method:: protected configure() + :Source: + `/GenerateDocumentationCommand.php#40 `_ + @@ -37,6 +54,9 @@ Methods .. php:method:: protected execute( $input, $output) + :Source: + `/GenerateDocumentationCommand.php#53 `_ + diff --git a/docs/api/JuliusHaertl/PHPDocToRst/Middleware/ErrorHandlingMiddleware.rst b/docs/api/JuliusHaertl/PHPDocToRst/Middleware/ErrorHandlingMiddleware.rst index 5eb1fd9..b570fca 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/Middleware/ErrorHandlingMiddleware.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/Middleware/ErrorHandlingMiddleware.rst @@ -17,18 +17,35 @@ ErrorHandlingMiddleware .. rst-class:: phpdoc-description - | Class ErrorHandlingMiddleware + | Class ErrorHandlingMiddleware\. + :Source: + `/Middleware/ErrorHandlingMiddleware.php#33 `_ + :Implements: :php:interface:`phpDocumentor\\Reflection\\Middleware\\Middleware` + +Summary +------- + +Methods +~~~~~~~ + +* :php:meth:`public \_\_construct\($apiDocBuilder\)` +* :php:meth:`public execute\($command, $next\)` + + Properties ---------- .. php:attr:: private static apiDocBuilder + :Source: + `/Middleware/ErrorHandlingMiddleware.php#35 `_ + Methods @@ -38,6 +55,9 @@ Methods .. php:method:: public __construct( $apiDocBuilder) + :Source: + `/Middleware/ErrorHandlingMiddleware.php#37 `_ + @@ -51,6 +71,9 @@ Methods | Executes this middleware class\. + :Source: + `/Middleware/ErrorHandlingMiddleware.php#50 `_ + :Parameters: * **$command** (:any:`phpDocumentor\\Reflection\\Php\\Factory\\File\\CreateCommand `) diff --git a/docs/api/JuliusHaertl/PHPDocToRst/WriteException.rst b/docs/api/JuliusHaertl/PHPDocToRst/WriteException.rst index 6fa480b..eb7ce39 100755 --- a/docs/api/JuliusHaertl/PHPDocToRst/WriteException.rst +++ b/docs/api/JuliusHaertl/PHPDocToRst/WriteException.rst @@ -15,10 +15,17 @@ WriteException .. rst-class:: phpdoc-description - | An exception for writing failure of files/directories in the build process + | An exception for writing failure of files/directories in the build process\. + :Source: + `/WriteException.php#28 `_ + :Parent: :php:class:`Exception` + +Summary +------- + diff --git a/src/Builder/PhpDomainBuilder.php b/src/Builder/PhpDomainBuilder.php index ff550a4..6e1819f 100755 --- a/src/Builder/PhpDomainBuilder.php +++ b/src/Builder/PhpDomainBuilder.php @@ -223,12 +223,8 @@ protected function addDocblockTag($tagName, DocBlock $docBlock) $tags = $docBlock->getTagsByName($tagName); - if (!in_array($tagName, $inclusion_tag_name)) { - return ''; - } - - if (in_array($tagName, $inclusion_tag_name) && count($tags) === 0) { - return ''; + if (!in_array($tagName, $inclusion_tag_name) || (in_array($tagName, $inclusion_tag_name) && count($tags) === 0)) { + return; } switch ($tagName) { @@ -519,9 +515,7 @@ private function processMethodArgumentTypes(Method $method): string foreach ($method->getArguments() as $argument) { $args = $this->processMethodArgumentType($argument, $args); } - $args = substr($args, 0, -2); - - return $args; + return substr($args, 0, -2); } /** diff --git a/tests/DocGenerationTest.php b/tests/DocGenerationTest.php index ee1be2c..9a4f6ca 100755 --- a/tests/DocGenerationTest.php +++ b/tests/DocGenerationTest.php @@ -20,7 +20,14 @@ public function testBuildDocumentation() $apiDocBuilder = new ApiDocBuilder($src, $dst); $apiDocBuilder->setVerboseOutput(true); $apiDocBuilder->setDebugOutput(true); + //$apiDocBuilder->addExtension(PublicOnlyExtension::class); + //$apiDocBuilder->addExtension(NoPrivateExtension::class); + $apiDocBuilder->addExtension(TocExtension::class); $apiDocBuilder->addExtension(InterfaceImplementors::class); + $apiDocBuilder->addExtension(GithubLocationExtension::class, [ + __DIR__.'/../src', + 'http://github.com/abbadon1334/phpdoc-to-rst/' + ]); $apiDocBuilder->build(); } @@ -73,7 +80,7 @@ public function testDocumentingWithExtension() $apiDocBuilder->addExtension(TocExtension::class); $apiDocBuilder->addExtension(InterfaceImplementors::class); $apiDocBuilder->addExtension(GithubLocationExtension::class, [ - 'http://github.com/abbadon1334', + 'http://github.com/abbadon1334/phpdoc-to-rst', 'phpdoc-to-rst', 'master', ]);