SYSTEM - PHP Framework
Back to top  

docu

Docu Class provided by System to register docu_packages.

package

SYSTEM\DOCU

Methods

Generate HTML Docu by docu classname

generate(string $id) : array
static

Arguments

$id

string

Classname of Docu Package to generated

Response

array

Returns array with logs.

Generate Markdown Docu by docu classname

generate_md(string $id) : array
static

Arguments

$id

string

Classname of Docu Package to generated

Response

array

Returns array with logs.

Get a specific docu package by classname

get(string $id) : array
static

Arguments

$id

string

Class name of the package to be found

Response

array

Returns the specific config or throws an Error.

Get all registered docu packages

getAll() : array
static

Response

array

Returns array with all registered docu package class names.

Register a docu package

register(string $docu_package) : null
static

Arguments

$docu_package

string

Classname of Docu Package to be registered

Response

null

Returns null.

Properties

array Variable to store all registred docu_package classes

docu_packages :
static

Type(s)