class Documentable::Config

Contains information related to the configuration of the module.

Methods

method config

Defined as

method config(--> Hash)

Returns a Hash object containing the JSON file.

method kinds

Defined as

method kinds(--> Array[Hash])

Returns an Array containing all Kind entries found.

method url-prefix

Defined as

method url-prefix(--> Str)

Returns the url-prefix specified. '' by default.

method filename

Defined as

method filename(--> Str)

Returns the $filename of the configuration file used.

submethod BUILD

Defined as

submethod(Str :$filename)

Creates a Documentable::Config object using a $filename (see configuration file). If an error in the file is found, a X::Documentable::Config::InvalidConfig exception will be thrown.

method get-kind-config

Defined as

method get-kind-config(Kind $kind --> Hash)

Returns the configuration for a given $kind.

method get-categories

Defined as

method get-categories(Kind $kind)

Returns the categories of a $kind entry.

Type Graph