Documentation for method new assembled from the following types:

class Documentable::Index

From Documentable::Index

(Documentable::Index) method new

Defined as

method new(:$pod!, :@meta!, :$origin!)

• $pod: "" object.

• @meta: second-level separator associated to this object.

• $origin: Documentable::Primary object where this reference was found.

• $mame is assigned following the content of @meta:

• If @meta is equal to ["a", "b", "c"], then $name will be set to "c (a b)".

• If @meta is equal to ["a"], then $name will be set to "a".

• $kind will always be set to Kind::Reference.

class Documentable::Primary

From Documentable::Primary

(Documentable::Primary) method new

Defined as

method new(Str :$filename!, :$pod!)

$pod must follow this format:

=begin pod :kind("<kind>") :subkind("<subkind>") :category("<category>")
 
=TITLE title 
 
=SUBTITLE subtitle 
 
(...)
 
=end pod
 

If at least one of these elements is missing, a exception will be thrown.

$filename is the name of the file containing the pod. This attribute is useful because several pods can be present in the same file, at the same time.

class Documentable::Search

From Documentable::Search

(Documentable::Search) method new

Defined as

method new(:$registry)

Creates a new instance of the class.

class Documentable::Secondary

From Documentable::Secondary

(Documentable::Secondary) method new

Defined as

method new(:$kind!, :$name!, :@subkinds, :@categories, :$pod!, :$origin)

Creates a new Documentable::Secondary object. You should not create your own instances of this class. Instead of that, you should rely on Documentable::Primary and use its @.defs attribute.

The $pod object is "normalized" when you use this method. That means, its title is modified and headings level are rewritten to avoid style problems.