PHP Class Mpociot\Documentarian\Documentarian

Afficher le fichier Open project: mpociot/documentarian Class Usage Examples

Méthodes publiques

Méthode Description
config ( $folder, string $key = null ) : mixed Returns a config value
create ( $folder ) Create a new API documentation folder and copy all needed files/stubs
generate ( $folder ) : false | null Generate the API documentation using the markdown and include files

Method Details

config() public méthode

Returns a config value
public config ( $folder, string $key = null ) : mixed
$key string
Résultat mixed

create() public méthode

Create a new API documentation folder and copy all needed files/stubs
public create ( $folder )
$folder

generate() public méthode

Generate the API documentation using the markdown and include files
public generate ( $folder ) : false | null
$folder
Résultat false | null