mirror of
https://github.com/danog/phpdoc.git
synced 2024-11-26 20:14:51 +01:00
Update
This commit is contained in:
parent
5f2ca3d051
commit
ebfbb6ed79
21
README.md
Normal file
21
README.md
Normal 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)
|
@ -1 +0,0 @@
|
|||||||
phpdoc.daniil.it
|
|
@ -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`
|
||||||
|
@ -12,4 +12,7 @@ Simple markdown PHPDOC documentation generator with psalm type annotation suppor
|
|||||||
## Classes
|
## Classes
|
||||||
* [\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).
|
@ -194,6 +194,9 @@ abstract class GenericDoc
|
|||||||
|
|
||||||
$this->description
|
$this->description
|
||||||
$seeAlso
|
$seeAlso
|
||||||
|
|
||||||
|
---
|
||||||
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it).
|
||||||
EOF;
|
EOF;
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
|
@ -257,8 +257,10 @@ class PhpDoc
|
|||||||
$interfaces
|
$interfaces
|
||||||
$abstract
|
$abstract
|
||||||
$classes
|
$classes
|
||||||
$traits
|
$traits
|
||||||
|
|
||||||
|
---
|
||||||
|
Generated by [danog/phpdoc](https://phpdoc.daniil.it).
|
||||||
EOF;
|
EOF;
|
||||||
|
|
||||||
$fName = $this->output;
|
$fName = $this->output;
|
||||||
|
Loading…
Reference in New Issue
Block a user