From ebfbb6ed7907cb655173d8b160a6b0df1a1c1b19 Mon Sep 17 00:00:00 2001 From: Daniil Gentili Date: Thu, 15 Oct 2020 18:25:35 +0200 Subject: [PATCH] Update --- README.md | 22 +++++++++++++++++++++- docs/CNAME | 1 - docs/danog/PhpDoc/PhpDocBuilder.md | 3 +++ docs/index.md | 5 ++++- src/PhpDoc/GenericDoc.php | 3 +++ src/PhpDoc/PhpDoc.php | 4 +++- 6 files changed, 34 insertions(+), 4 deletions(-) mode change 120000 => 100644 README.md delete mode 100644 docs/CNAME diff --git a/README.md b/README.md deleted file mode 120000 index e892330..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -docs/index.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..370dbd9 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# danog/phpdoc + +Simple markdown PHPDOC documentation generator with psalm type annotation support. + +Supports, classes, abstract classes, interfaces, traits and functions thanks to [danog/class-finder](https://github.com/danog/class-finder). + +## Install + +``` +composer require danog/phpdoc --dev +``` + +## Run + +``` +vendor/bin/phpdoc outputDirectory [ namespace ] +``` + +If not provided, `namespace` will default to the namespace of the current package. + +## [API documentation](docs) diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index 9b99d71..0000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -phpdoc.daniil.it \ No newline at end of file diff --git a/docs/danog/PhpDoc/PhpDocBuilder.md b/docs/danog/PhpDoc/PhpDocBuilder.md index a523360..1815613 100644 --- a/docs/danog/PhpDoc/PhpDocBuilder.md +++ b/docs/danog/PhpDoc/PhpDocBuilder.md @@ -13,6 +13,9 @@ PHP documentation builder. + +--- +Generated by [danog/phpdoc](https://phpdoc.daniil.it). ## Method list: * `fromNamespace(string $namespace): self` * `setAuthors(\phpDocumentor\Reflection\DocBlock\Tags\Author[] $authors): self` diff --git a/docs/index.md b/docs/index.md index 8f6601d..4addced 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,4 +12,7 @@ Simple markdown PHPDOC documentation generator with psalm type annotation suppor ## Classes * [\danog\PhpDoc\PhpDocBuilder: PHP documentation builder.](danog/PhpDoc/PhpDocBuilder.md) - + + +--- +Generated by [danog/phpdoc](https://phpdoc.daniil.it). \ No newline at end of file diff --git a/src/PhpDoc/GenericDoc.php b/src/PhpDoc/GenericDoc.php index 498909b..05e7dc0 100644 --- a/src/PhpDoc/GenericDoc.php +++ b/src/PhpDoc/GenericDoc.php @@ -194,6 +194,9 @@ abstract class GenericDoc $this->description $seeAlso + + --- + Generated by [danog/phpdoc](https://phpdoc.daniil.it). EOF; } /** diff --git a/src/PhpDoc/PhpDoc.php b/src/PhpDoc/PhpDoc.php index 6fee359..69e8ef4 100644 --- a/src/PhpDoc/PhpDoc.php +++ b/src/PhpDoc/PhpDoc.php @@ -257,8 +257,10 @@ class PhpDoc $interfaces $abstract $classes - $traits + $traits + --- + Generated by [danog/phpdoc](https://phpdoc.daniil.it). EOF; $fName = $this->output;