1fpdoc(1) Free Pascal unit documentation generator fpdoc(1)
2
6 fpdoc - The FPC Pascal unit documentation generator.
7
10 fpdoc --input=inputcommand [--output=output] [--format=fmt]
11 [--descr=descriptionfile] [--show-private] [--hide-protected]
12 [--lang=language] [--content=contentfile] [--import=importfile]
13 [--package=packagename] [--html-search=searchpage] [--ostarget=target]
14 [--cpu-target=target] [--latex-extension=ext] [--latex-highlight]
15
18 fpdoc scans a Free Pascal unit source file and generates documentation
19 for it. The documentation can be in various formats (currently HTML
20 and LaTeX) It can read various description files which contain the
21 description for the various symbols found in the unit file.
22
25 You can invoke fpdoc with as the only required argument the 'input' and
26 '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.
29
32 fpdoc has several options, most of them optional, defaults will be used
33 in most cases.
34 --content
37 This option tells fpdoc to generate a content file. A content
38 file contains a list of all the possible anchors (labels) in the
39 generated documentation file, and can be used to create cross-
40 links in documentation for different units, using the --import
41 option.
42 --descr=descfile
44 This option specifies the name of a description file descfile
45 that contains the actual documentation for the unit. This
46 option can be given several times, for several description
47 files.
48 --format=fmt
50 Specifies the format fmt in which the documentation will be gen‐
51 erated. Currenly, the following formats are known:
52 htm HTML with 8.3 conforming filenames.
54 html HTML with long filenames.
56 xhtml XHTML with long filesnames.
58 latex LaTex, which uses the fpc.sty style used by the Free Pas‐
60 cal documentation.
61 xml-struct
63 Structured XML.
64 --hide-protected
66 By default, the documentation will include descriptions and
67 listings of protected fields and methods in classes or objects.
68 This option changes this behaviour; if it is specified, no docu‐
69 mentation will be generated for these methods. Note that public
70 methods or properties that refer to these protected method will
71 then have a dangling (i.e. unavailable) link.
72 --html-search=link
74 Adds an entry for an HTML search page at location link in the
75 headers of the generated HTML pages. There is no search page
76 provided, this should be made and provided by the user.
77 --import=impfile
79 imports a content file impfile from another documentation set.
80 This can be used to resolve references to elements within this
81 other documentation file;
82 --input=cmd
84 This option tells fpdoc what input file should be used. The
85 argument cmd can be just a filename, but can also be a complete
86 compiler command-line with options that concern the scanning of
87 the pascal source: defines, include files, syntax options, as
88 they would be specified to the free pascal compiler when compil‐
89 ing the file. If a complete command is used, then it should be
90 enclosed in single or double quotes, so the shell will not break
91 them in parts. It is possible to specify multiple input com‐
92 mands; they will be treated one by one, and documentation will
93 be generated for each of them.
94 --lang=language
96 Sets the language for the output file. This will mainly set the
97 strings used for the headers in various parts of the documenta‐
98 tion files (by default they're in english). Currently, valid
99 options are
100 de German.
102 fr French.
104 nl Dutch.
106 --latex-extension=ext
108 Sets the extension to use for the LaTeX file to ext the default
109 is .tex (with . (dot) included).
110 --latex-highlight
112 Switches on an internal latex syntax highlighter. This is not
113 yet implemented. By default, syntax highlighting is provided by
114 the syntax package that comes with fpc.
115 --output=name
117 This option tells fpdoc where the output file should be gener‐
118 ated. How this option is interpreted depends on the format that
119 is used. For latex, name is interpreted as the filename for the
120 tex file. For all other formats, name is interpreted as the
121 directory where all documentation files will be written. The
122 directory will be created if it does not yet exist. Standard
123 this equals the package name.
124 --package=packagename
126 Specifies the package name. All units will be documented as part
127 of packagename , which is also the default output filename or
128 directory. Only documentation nodes inside a package node with
129 this name will be considered when documenting.
130 --show-private
132 By default, no documentation is generated for private methods or
133 fields. This option causes fpdoc to generate documentation for
134 these methods as well.
135 --warn-no-node
137 If this option is specified, fpdoc will emit a warning if it
138 does not find a description node for an identifier it is docu‐
139 menting.
140
143 ppc386(1) latex(1) makeskel(1)
144Free Pascal 9 march 2002 fpdoc(1)