File: ur-update-pod.pod

package info (click to toggle)
libur-perl 0.470%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 7,184 kB
  • sloc: perl: 61,813; javascript: 255; xml: 108; sh: 13; makefile: 9
file content (67 lines) | stat: -rw-r--r-- 1,001 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67


=pod

=head1 NAME

ur update pod - generate man-page-like POD for a commands



=head1 VERSION

This document describes ur update pod version 0.29.

(built on 2011-03-07 at 10:34:30)

=head1 SYNOPSIS

ur update pod [--input-path=?] [--output-path=?] EXECUTABLE-NAME CLASS-NAME TARGETS

ur update pod -i ./lib -o ./pod ur UR::Namespace::Command


=head1 REQUIRED ARGUMENTS

=over


=item EXECUTABLE-NAME  I<Text>

the name of the executable to document

=item CLASS-NAME  I<Text>

the command class which maps to the executable

=item TARGETS  I<Text>

specific classes to document (documents all unless specified)


=back

=head1 OPTIONAL ARGUMENTS

=over


=item input-path  I<Path>

optional location of the modules to document

=item output-path  I<Text>

optional location to output .pod files


=back

=head1 DESCRIPTION:

This tool generates POD documentation for each all of the commands in a tree for a given executable.

This command must be run from within the namespace directory.

=cut