PHP Class Mpociot\Documentarian\Documentarian

显示文件 Open project: mpociot/documentarian Class Usage Examples

Public Methods

Method 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 method

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

create() public method

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

generate() public method

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