1
0
mirror of https://github.com/danog/phpdoc.git synced 2024-11-26 20:14:51 +01:00
This commit is contained in:
Daniil Gentili 2020-10-15 18:25:35 +02:00
parent 5f2ca3d051
commit ebfbb6ed79
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
6 changed files with 34 additions and 4 deletions

View File

@ -1 +0,0 @@
docs/index.md

21
README.md Normal file
View File

@ -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)

View File

@ -1 +0,0 @@
phpdoc.daniil.it

View File

@ -13,6 +13,9 @@ PHP documentation builder.
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it).
## Method list: ## Method list:
* `fromNamespace(string $namespace): self` * `fromNamespace(string $namespace): self`
* `setAuthors(\phpDocumentor\Reflection\DocBlock\Tags\Author[] $authors): self` * `setAuthors(\phpDocumentor\Reflection\DocBlock\Tags\Author[] $authors): self`

View File

@ -13,3 +13,6 @@ Simple markdown PHPDOC documentation generator with psalm type annotation suppor
* [\danog\PhpDoc\PhpDocBuilder: PHP documentation builder.](danog/PhpDoc/PhpDocBuilder.md) * [\danog\PhpDoc\PhpDocBuilder: PHP documentation builder.](danog/PhpDoc/PhpDocBuilder.md)
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it).

View File

@ -194,6 +194,9 @@ abstract class GenericDoc
$this->description $this->description
$seeAlso $seeAlso
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it).
EOF; EOF;
} }
/** /**

View File

@ -259,6 +259,8 @@ class PhpDoc
$classes $classes
$traits $traits
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it).
EOF; EOF;
$fName = $this->output; $fName = $this->output;