1makeskel(1)           FPC unit description file generator          makeskel(1)
2
3
4

NAME

6       makeskel - generate description file for fpdoc.
7
8

SYNOPSIS

10       makeskel  [--descr=filename]  [--disable-arguments]  [--disable-errors]
11       [--disable-function-results] [--disable-private]  [--disable-protected]
12       [--disable-seealso] [--emit-class-separator] [--help] [--lang=language]
13       [--output=filename] [--update] --package=name --input=cmdline
14
15

Description

17       makeskel scans a Free Pascal unit source file and generates a  skeleton
18       description  file  for it. It generates nodes for all identifiers found
19       in the interface section of the unit, although this  behaviour  can  be
20       adjusted  with  some  options. It can also update an existing XML file,
21       and then emits only nodes for identifiers for which no node exists yet.
22
23

Usage

25       You can invoke makeskel with as the only required arguments  the  input
26       and  package arguments. It should at least contain the name of the unit
27       file for which documentation should be generated and the  name  of  the
28       package  to  which  the unit belongs. The output of makeskel will go to
29       standard output by default.
30
31

Options

33       makeskel has many options, most of them optional, defaults will be used
34       in most cases.
35
36
37       --descr=descfile
38              This  option must be used in conjunction with the update option.
39              It specifies the name of a description file descfile which  must
40              be  updated.  Note  that the file must contain valid XML, or the
41              update will fail. This option can be specified more than once.
42
43       --disable-arguments
44              If this option is specified, makeskel will not  emit  nodes  for
45              the  arguments of functions and procedures. By default, documen‐
46              tation nodes are emitted for functions and procedures as well.
47
48       --disable-errors
49              By default, each documentation node will contain a  errors  node
50              as  well  (excep  for identifiers where this has no use, such as
51              function arguments). If this option is specified, no errors node
52              will be generated.
53
54       --disable-function-results
55              By  default,  for functions, a result node will be generated, to
56              describe the result of the function. If this  option  is  speci‐
57              fied, no function result node will be generated.
58
59       --disable-private
60              By  default,  documentation nodes are also generated for private
61              fields or methods of a class. if this option is  specified,  the
62              generation of nodes for private fields or methods is skipped.
63
64       --disable-protected
65              By default, documentation nodes are also generated for protected
66              fields or methods of a class. if this option is  specified,  the
67              generation of nodes for protected fields or methods is skipped.
68
69       --emit-class-separator
70              If  this option is specified, a visible comment with the name of
71              the class for which documentation nodes will follow, is inserted
72              between the nodes of two classes, making navigation easier.
73
74       --help Emit a short help text and exit.
75
76       --input=cmd
77              The  input (source) file to process. Multiple input files can be
78              specified.  The command may contain valid compiler options, cur‐
79              rently  the  -Fipath  (search  path)  and -dmacro (define macro)
80              options are recognized.
81
82       --lang=language
83              Sets the language for the output file. This will mainly set  the
84              strings  used for the headers in various parts of the documenta‐
85              tion files (by default they're  in  english).  Currently,  valid
86              options are
87
88              de     German.
89
90              fr     French.
91
92              nl     Dutch.
93
94       --output=filename
95              This  option  tells makeskel where the output should go. If this
96              option is not specified, the output is sent to  standard  output
97              (the screen).
98
99       --package=packagename
100              This  option  is required. It specifies the name of the package.
101              All nodes will be generated inside a node  with  name  attribute
102              packagename.
103
104       --update
105              Turns  on  update mode. In this mode, the output is a file which
106              contains only the missing nodes to complete the documentation of
107              the  input  files. The existing nodes must be specified with the
108              descr argument. Note that the output file may not be the same as
109              the input (description) nodes; A separate file must be specified
110              (or no file, in which case output goes to standard output.
111
112

SEE ALSO

114              ppc386(1) latex(1) fpdoc(1)
115
116
117
118Free Pascal                    11 November 2004                    makeskel(1)
Impressum