Documentation for submethod BUILD assembled from the following types:

class Perl6::Documentable

From Perl6::Documentable

(Perl6::Documentable) submethod BUILD

Defined as

submethod BUILD(:$!name, :$!kind!, :@!subkinds, :@!categories, :$!pod!)

Returns a Perl6::Documentable object correctly initialized.

class Perl6::Documentable::Registry

From Perl6::Documentable::Registry

(Perl6::Documentable::Registry) submethod BUILD

Defined as

submethod BUILD(Str :$topdir = "doc", :@dirs = [], Bool :$verbose = True,
                Bool :$use-cache = True)

Creates a new instance of the class.

• $topdir: directory containing all the pod6 sources.

• @dirs: subdirectories of $topdir containing pod6 sources.

• $verbose: if True, additional information will be printed.

• $use-cache: use Pod::To::Cached to create a pod6 cache.

Example:

use Perl6::Documentable::Registry;
 
my $registry = Perl6::Documentable::Registry.new(
    topdir    => "doc",                # doc containing the pod collection 
    dirs      => ["Type", "Language"], # dirs to process 
    verbose   => True,
    use-cache => True                  # recommended 
);
 
# to complete the processing and initialize some attributes 
$registry.compose;
 

Note: if $use-cache is set to False, Pod::Load will be used instead.

class Perl6::Documentable::Config

From Perl6::Documentable::Config

(Perl6::Documentable::Config) submethod BUILD

Defined as

submethod(Str :$filename)

Creates a Perl6::Documentable::Config object using a file. See configuration file.

If an error in the file is found, a X::Documentable::Config::InvalidConfig exception will be thrown.