initial import

Author: axelhahn

Readme.md

@@ -0,0 +1,12 @@
+# PHP Doc generator (BETA)
+
+A class and cli script to generate a markdown doc page from a class file.
+
+You can customize the output or create output in another wanted format.
+
+Compatible to PHP 8.3
+
+👤 Author: Axel Hahn
+📄 Source: <https://github.com/axelhahn/php-classdoc>
+📜 License: GNU GPL 3.0
+📗 Docs: TODO

config/md/index.tpl

@@ -0,0 +1,14 @@
+## Class {{name}}
+
+{{comment}}
+
+## Properties
+
+{{properties.tpl}}
+
+## Methods
+
+{{methods.tpl}}
+
+---
+Generated with Axels PHP class doc parser.

config/md/methods.tpl

@@ -0,0 +1,10 @@
+### {{type}}{{name}}
+
+{{comment}}
+
+**Parameters**: **{{parameters_count}}** (required: {{parameters_required}})
+
+{{parameters.tpl}}
+
+**Return**: {{returntype}}
+

config/md/parameter.tpl

@@ -0,0 +1 @@
+{{string}} | {{type}} | {{phpdoc_descr}}

config/md/parameters.tpl

@@ -0,0 +1,3 @@
+| Parameter | Type | Description
+|--         |--    |--
+{{parameter.tpl}}

config/md/properties.tpl

@@ -0,0 +1,8 @@
+### {{type}}${{name}}
+
+{{comment}}
+
+type: {{vartype}}
+
+default value: {{defaultvalue}}
+

docs/70_Class.md

@@ -0,0 +1,118 @@
+## Class axelhahn\phpclassparser
+
+
+PHP CLASS PARSER
+@author axelhahn
+@license GNU GPL 3.0
+
+@source <https://github.com/axelhahn/TODO>
+
+
+
+## Properties
+
+(none)
+
+## Methods
+
+### public __construct
+
+
+Constructs a new instance of the class.
+
+
+
+**Parameters**: **1** (required: 0)
+
+| Parameter | Type | Description
+|--         |--    |--
+\<optional\> string $sClassname = '' | string | optional: The name of the class. Default is an empty string.
+
+
+
+**Return**: 
+
+### public getClassInfos
+
+
+
+**Parameters**: **0** (required: 0)
+
+
+
+**Return**: array
+
+### public getMethods
+
+
+Get a hash of methods with its type, parameters, phpdoc infos
+
+
+**Parameters**: **1** (required: 0)
+
+| Parameter | Type | Description
+|--         |--    |--
+\<optional\> $bPublicOnly = true | string * | flag: public only methods or all; default: true (=only public methods)
+
+
+
+**Return**: array
+
+### public getProperties
+
+
+Get a hash of properties with its type, phpdoc infos, default value, attributes, etc.
+
+
+
+**Parameters**: **1** (required: 0)
+
+| Parameter | Type | Description
+|--         |--    |--
+\<optional\> $bPublicOnly = true | bool * | flag: public only properties or all; default: true (=only public properties)
+
+
+
+**Return**: array
+
+### public setClassFile
+
+
+Sets the class file to be analyzed.
+It will detect namespace and class name to initialize the class.
+
+
+
+**Parameters**: **1** (required: 1)
+
+| Parameter | Type | Description
+|--         |--    |--
+\<required\> string $file | string | The path to the class file.
+
+
+
+**Return**: string|bool
+
+### public setClassname
+
+
+Set a classname. 
+You can use that method directly if the class file was loaded before. 
+Or use setClassFile() to load the class file and detect the classname.
+@see setClassFile()
+
+
+**Parameters**: **1** (required: 1)
+
+| Parameter | Type | Description
+|--         |--    |--
+\<required\> string $sClassname | string | classname to access for doc generation
+
+
+
+**Return**: void
+
+
+
+---
+Generated with Axels PHP class doc parser.