|
@@ -0,0 +1,147 @@
|
|
|
|
|
+.TH fpdoc 1 "9 march 2002" "Free Pascal" "Free Pascal unit documentation generator"
|
|
|
|
|
+.SH NAME
|
|
|
|
|
+fpdoc \- The FPC Pascal unit documentation generator.
|
|
|
|
|
+
|
|
|
|
|
+.SH SYNOPSIS
|
|
|
|
|
+
|
|
|
|
|
+\fBfpdoc\fP --input=inputcommand [--output=output] [--format=fmt]
|
|
|
|
|
+[--descr=descriptionfile] [--show-private] [--hide-protected]
|
|
|
|
|
+[--lang=language] [--content=contentfile] [--import=importfile]
|
|
|
|
|
+[--package=packagename] [--html-search=searchpage]
|
|
|
|
|
+
|
|
|
|
|
+.SH Description
|
|
|
|
|
+
|
|
|
|
|
+.B fpdoc
|
|
|
|
|
+scans a Free Pascal unit source file and generates documentation for it.
|
|
|
|
|
+The documentation can be in various formats (currently HTML and LaTeX)
|
|
|
|
|
+It can read various description files which contain the description for the
|
|
|
|
|
+various symbols found in the unit file.
|
|
|
|
|
+.SH Usage
|
|
|
|
|
+
|
|
|
|
|
+You can invoke
|
|
|
|
|
+.B fpdoc
|
|
|
|
|
+with as the only required argument the 'input' argument. It should at least
|
|
|
|
|
+contain the name of the unit file for which documentation should be
|
|
|
|
|
+generated.
|
|
|
|
|
+
|
|
|
|
|
+.SH Options
|
|
|
|
|
+
|
|
|
|
|
+.B fpdoc
|
|
|
|
|
+has several options, most of them optional, defaults will be used in most
|
|
|
|
|
+cases.
|
|
|
|
|
+
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-content
|
|
|
|
|
+This option tells
|
|
|
|
|
+.B fpdoc
|
|
|
|
|
+to generate a content file. A content file contains a list of all the
|
|
|
|
|
+possible anchors (labels) in the generated documentation file, and can be
|
|
|
|
|
+used to create cross-links in documentation for different units, using the
|
|
|
|
|
+.B --import
|
|
|
|
|
+option.
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-descr=descfile
|
|
|
|
|
+This option specifies the name of a description file
|
|
|
|
|
+.B descfile
|
|
|
|
|
+that contains the actual documentation for the unit.
|
|
|
|
|
+This option can be given several times, for several description files.
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-format=fmt
|
|
|
|
|
+Specifies the format
|
|
|
|
|
+.B fmt
|
|
|
|
|
+in which the documentation will be generated. Currenly,
|
|
|
|
|
+the following formats are known:
|
|
|
|
|
+.RS
|
|
|
|
|
+.TP
|
|
|
|
|
+.I htm
|
|
|
|
|
+HTML with 8.3 conforming filenames.
|
|
|
|
|
+.TP
|
|
|
|
|
+.I html
|
|
|
|
|
+HTML with long filenames.
|
|
|
|
|
+.TP
|
|
|
|
|
+.I xhtml
|
|
|
|
|
+XHTML with long files,ames.
|
|
|
|
|
+.TP
|
|
|
|
|
+.I latex
|
|
|
|
|
+LaTex, which uses the fpc.sty style used by the Free Pascal documentation.
|
|
|
|
|
+.TP xml-struct
|
|
|
|
|
+Structured XML.
|
|
|
|
|
+.RE
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-hide\-protected
|
|
|
|
|
+By default, the documentation will include descriptions and listings of
|
|
|
|
|
+protected fields and methods in classes or objects. This option changes this
|
|
|
|
|
+behaviour; if it is specified, no documentation will be generated for these
|
|
|
|
|
+methods. Note that public methods or properties that refer to these
|
|
|
|
|
+protected method will then have a dangling (i.e. unavailable) link.
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-html\-search=link
|
|
|
|
|
+Adds an entry for an HTML search page at location
|
|
|
|
|
+.B link
|
|
|
|
|
+in the headers of the generated HTML pages. There is no search page
|
|
|
|
|
+provided, this should be made and provided by the user.
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-import=impfile
|
|
|
|
|
+imports a content file
|
|
|
|
|
+.B impfile
|
|
|
|
|
+from another documentation set. This can be used to
|
|
|
|
|
+resolve references to elements within this other documentation file;
|
|
|
|
|
+.TP
|
|
|
|
|
+.B \-\-input=cmd
|
|
|
|
|
+This option tells
|
|
|
|
|
+.B fpdoc
|
|
|
|
|
+what input file should be used. The argument
|
|
|
|
|
+.B cmd
|
|
|
|
|
+ can be just a filename, but can
|
|
|
|
|
+also be a complete compiler command-line with options that concern the
|
|
|
|
|
+scanning of the pascal source: defines, include files, syntax options,
|
|
|
|
|
+as they would be specified to the free pascal compiler when compiling
|
|
|
|
|
+the file. If a complete command is used, then it should be enclosed in
|
|
|
|
|
+single or double quotes, so the shell will not break them in parts.
|
|
|
|
|
+It is possible to specify multiple input commands; they will be treated one
|
|
|
|
|
+by one, and documentation will be generated for each of them.
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-lang=language
|
|
|
|
|
+Sets the language for the output file. This will mainly set the strings used
|
|
|
|
|
+for the headers in various parts of the documentation files (by default
|
|
|
|
|
+they're in english). Currently, valid options are
|
|
|
|
|
+.RS
|
|
|
|
|
+.TP
|
|
|
|
|
+.I de
|
|
|
|
|
+German.
|
|
|
|
|
+.TP
|
|
|
|
|
+.I fr
|
|
|
|
|
+French.
|
|
|
|
|
+.TP
|
|
|
|
|
+.I nl
|
|
|
|
|
+Dutch.
|
|
|
|
|
+.RE
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-latex\-highlight
|
|
|
|
|
+Switches on an internam latex syntax highlighter. This is not yet
|
|
|
|
|
+implemented. By default, syntax highlighting is provided by the syntax
|
|
|
|
|
+package that comes with fpc.
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-output=name
|
|
|
|
|
+This option tells
|
|
|
|
|
+.B fpdoc
|
|
|
|
|
+where the output file should be generated. How this option is interpreted
|
|
|
|
|
+depends on the format that is used. For latex,
|
|
|
|
|
+.B name
|
|
|
|
|
+is interpreted as the
|
|
|
|
|
+filename for the tex file. For all other formats,
|
|
|
|
|
+.B name
|
|
|
|
|
+is interpreted as
|
|
|
|
|
+the directory where all documentation files will be written. The directory
|
|
|
|
|
+will be created if it does not yet exist.
|
|
|
|
|
+.TP
|
|
|
|
|
+.BI \-\-show\-private
|
|
|
|
|
+By default, no documentation is generated for private methods or fields.
|
|
|
|
|
+This option causes
|
|
|
|
|
+.B fpdoc
|
|
|
|
|
+to generate documentation for these methods as well.
|
|
|
|
|
+
|
|
|
|
|
+.SH SEE ALSO
|
|
|
|
|
+.IP
|
|
|
|
|
+.BR ppc386 (1)
|
|
|
|
|
+.BR latex (1)
|
michael