Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 110 lines (59 sloc) 1.611 kb
d5f3b1b @petdance Importing from Andy original repo
authored
1 =head1 POD
2
3 Plain Ol' Documentation
4
5 =head2 Inline documentation & formatting
6
7 POD allows you to create documentation with markup in your Perl code.
8
9 If you've seen Javadoc or PHPdoc, it's like that.
10
11 Rather, Javadoc and PHPdoc are like POD.
12
13 Except that POD is part of the language, not an add-on spec.
14
15 =head2 Headings
16
17 =head1 MOST IMPORTANT
18
19 Blah blah
20
21 =head2 Subheading
22
23 blah blah
24
25 =head2 Subhading
26
27 blah blah
28
29 =head2 Lists
30
31 To create this list:
32
33 =over
34
35 =item * Wango
36
37 =item * Tango
38
39 =item * Fandango
40
41 =back
42
43 Use
44
45 =head2 PARAMETERS
46
47 You must pass in three parms:
48
49 =over
50
51 =item * Wango
52
53 =item * Tango
54
55 =item * Fandango
56
57 =back
58
59 =head2 Style markup
60
61 B<This is bolded>
62
63 I<This is italics>
64
65 C<This is code>
66
67 B<bold>
68
69 I<italics>
70
71 C<code>
72
73 Your markup formats can nest.
74
75 =head2 Link with C<< L<> >>
76
77 The C<< L<> >> links either to keywords in your document, as in
78 C<< L<Methods> >>, or to a specific URL, as in
79 C<< L<http://search.cpan.org> >>.
80
81 =head2 Paragraph mode vs. literal blocks
82
83 Everything in a paragraph word-wraps automatically. A paragraph
84 is separated by at least one blank line.
85
86 A literal block is indented at least one space
87 and does not
88 get
89 wrapped.
90
91 This came from:
92
93 Everything in a paragraph word-wraps automatically. A paragraph
94 is separated by at least one blank line.
95
96 A literal block is indented at least one space
97 and does not
98 get
99 wrapped.
100
101 =head2 POD does not make anything run slower.
102
103 It's stripped out at compile time.
104
105 =head2 TODO
106
107 Talk about double-bracketing
108
109
Something went wrong with that request. Please try again.