Skip to content

Commit a061271

Browse files
lizmatlizmat
committed
Provide some linkage and SUBTITLEs
1 parent a5baa20 commit a061271

File tree

6 files changed

+38
-33
lines changed

6 files changed

+38
-33
lines changed

‎doc/Type/RakuAST/Doc.rakudoc

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,11 @@ Relations between the C<RakuAST::Doc::> classes:
3232
\- RakuAST::Doc::Block
3333

3434
Note that this structure is recursive with regards to the
35-
C<RakuAST::Doc::Block> object (which can occur as an element
36-
of the paragraphs of a C<RakuAST::Doc::Block>), and the
37-
C<RakuAST::Doc::Markup> object (which can occur as an element
38-
of the atoms of a C<RakuAST::Doc::Markup>).
35+
L«C<RakuAST::Doc::Block>|/type/RakuAST/Doc/Block» object (which can
36+
occur as an element of the paragraphs of a C<RakuAST::Doc::Block>),
37+
and the L«C<RakuAST::Doc::Markup>|/type/RakuAST/Doc/Markup» object
38+
(which can occur as an element of the atoms of a
39+
C<RakuAST::Doc::Markup>).
3940

4041
=head2 class RakuAST::Doc::Block
4142

@@ -46,22 +47,23 @@ of a string (which implies there is no extra markup in there) or
4647
a C<RakuAST::Doc::Paragraph> object, or another C<RakuAST::Doc::Block>
4748
in the case of C<RakuDoc> blocks embedding other blocks.
4849

49-
A C<RakuAST::Doc::Block> typically occurs in C<RakuAST::StatementList>
50-
objects when it is the result of parsing Raku Programming Language
51-
code, or C<RakuDoc> documentation.
50+
A C<RakuAST::Doc::Block> typically occurs in
51+
L«C<RakuAST::StatementList>|/type/RakuAST/StatementList» objects when
52+
it is the result of parsing Raku Programming Language code, or
53+
C<RakuDoc> documentation.
5254

5355
=head2 class RakuAST::Doc::Paragraph
5456

55-
The C<RakuAST::Doc::Paragraph> object contains the information about
56-
the atoms that constitute the paragraph. Each atom may be either a
57-
string or a C<RakuAST::Doc::Markup> object.
57+
The L«C<RakuAST::Doc::Paragraph>|/type/RakuAST/Doc/Paragraph» object
58+
contains the information about the atoms that constitute the paragraph.
59+
Each atom may be either a string or a C<RakuAST::Doc::Markup> object.
5860

5961
=head2 class RakuAST::Doc::Markup
6062

61-
The C<RakuAST::Doc::Markup> object contains the information about
62-
a markup atom, and itself contains a list of atoms. Each atom may
63-
be either a string or a C<RakuAST::Doc::Markup> object in the case
64-
of embedded markup.
63+
The L«C<RakuAST::Doc::Markup>|/type/RakuAST/Doc/Markup» object contains
64+
the information about a markup atom, and itself contains a list of
65+
atoms. Each atom may be either a string or a C<RakuAST::Doc::Markup>
66+
object in the case of embedded markup.
6567

6668
=head2 EXAMPLE
6769

@@ -105,15 +107,15 @@ is represented in C<RakuAST::Doc::> objects like this:
105107

106108
=head2 class RakuAST::Doc::Declarator
107109

108-
The C<RakUAST::Doc::Declarator> object contains the leading and
109-
trailing documentation of a C<RakuAST> object doing the
110-
C<RakuAST::Doc::DeclaratorTarget> role.
110+
The L«C<RakuAST::Doc::Declarator>|/type/RakuAST/Doc/Declarator»
111+
object contains the leading and trailing documentation of a
112+
C<RakuAST> object doing the C<RakuAST::Doc::DeclaratorTarget> role.
111113

112114
=head2 role RakuAST::Doc::DeclaratorTarget
113115

114-
The C<RakuAST::Doc::DeclaratorTarget> role is done by C<RakuAST>
115-
objects that allow leading and/or trailing documentation when
116-
used in Raku source code.
116+
The L«C<RakuAST::Doc::DeclaratorTarget>|/type/RakuAST/Doc/DeclaratorTarget»
117+
role is done by C<RakuAST> objects that allow leading and/or trailing
118+
documentation when used in Raku source code.
117119

118120
=head2 EXAMPLE
119121

@@ -144,8 +146,8 @@ C<.declarator-docs> call.
144146

145147
This is needed to create a single-statement representation
146148
of the target object (in this case the
147-
C<RakuAST::VarDeclaration::Simple> object) and its associated
148-
C<RakuAST::Doc::Declarator> object.
149+
L«C<RakuAST::VarDeclaration::Simple>|/type/RakuAST/VarDeclaration/Simple»
150+
object) and its associated C<RakuAST::Doc::Declarator> object.
149151

150152
That is because objects doing the C<RakuAST::Doc::DeclaratorTarget>
151153
refer to the associated C<RakuAST::Doc::Declarator> object in

‎doc/Type/RakuAST/Doc/Block.rakudoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
=TITLE class RakuAST::Doc::Block
44

5-
=SUBTITLE
5+
=SUBTITLE Contains the information of a RakuDoc block
66

77
class RakuAST::Doc::Block { }
88

@@ -63,7 +63,8 @@ C<literalize-config> method must be called once first.
6363
}
6464

6565
Returns a C<List> of the paragraphs. Note that each element can
66-
either be a string, a C<RakuAST::Doc::Paragraph> or another
66+
either be a string, a
67+
L«C<RakuAST::Doc::Paragraph>|/type/RakuAST/Doc/Paragraph» or another
6768
C<RakuAST::Doc::Block> object.
6869

6970
=head3 method delimited

‎doc/Type/RakuAST/Doc/Declarator.rakudoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
=TITLE class RakuAST::Doc::Declarator
44

5-
=SUBTITLE
5+
=SUBTITLE Contains the declarator docs of a RakuAST object
66

77
class RakuAST::Doc::Declarator { }
88

99
The C<RakuAST::Doc::Declarator> class contains the leading and trailing
10-
documentation of an object doing the C<RakuAST::Doc::DeclaratorTarget>
10+
documentation of an object doing the
11+
L«C<RakuAST::Doc::DeclaratorTarget>|/type/RakuAST/Doc/DeclaratorTarget»
1112
role.
1213

1314
Support for C<RakuAST> functionality is available in language version

‎doc/Type/RakuAST/Doc/DeclaratorTarget.rakudoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ created.
3030
say "trailing: $_.trailing()";
3131
}
3232

33-
Returns the C<RakuAST::Doc::Declarator> object containing the declarator
34-
documentation, if any.
33+
Returns the L«C<RakuAST::Doc::Declarator>|/type/RakuAST/Doc/Declarator»
34+
object containing the declarator documentation, if any.
3535

3636
=head1 Object creation
3737

‎doc/Type/RakuAST/Doc/Markup.rakudoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
=TITLE class RakuAST::Doc::Markup
44

5-
=SUBTITLE
5+
=SUBTITLE Contains the information about RakuDoc markup
66

77
class RakuAST::Doc::Markup { }
88

99
The C<RakuAST::Doc::Markup> class contains the information about
10-
markup codes in a C<RakuAST::Doc::Paragraph> or another
11-
C<RakuAST::Doc::Markup> object.
10+
markup codes in a L«C<RakuAST::Doc::Paragraph>|/type/RakuAST/Doc/Paragraph»
11+
or another C<RakuAST::Doc::Markup> object.
1212

1313
Support for C<RakuAST> functionality is available in language version
1414
C<6.e+> and was added in Rakudo compiler release 2023.02. In earlier

‎doc/Type/RakuAST/Doc/Paragraph.rakudoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
=TITLE class RakuAST::Doc::Paragraph
44

5-
=SUBTITLE
5+
=SUBTITLE Contains the information about a RakuDoc paragraph
66

77
class RakuAST::Doc::Paragraph { }
88

@@ -28,7 +28,8 @@ objects created.
2828
# Text before ␤B<and>␤ after markup␤
2929

3030
Returns the atoms of the paragraph. These are generally a mix of
31-
strings and C<RakuAST::Doc::Markup> objects.
31+
strings and L«C<RakuAST::Doc::Markup>|/type/RakuAST/Doc/Markup»
32+
objects.
3233

3334
=head3 method Str
3435

0 commit comments

Comments
 (0)