mirror of
https://gitlab.com/freepascal.org/fpc/source.git
synced 2025-08-12 13:49:39 +02:00
* Examples
git-svn-id: trunk@32376 -
This commit is contained in:
parent
74c79803f7
commit
c5495cb49c
13
.gitattributes
vendored
13
.gitattributes
vendored
@ -15703,6 +15703,16 @@ utils/fpdoc/dw_txt.pp svneol=native#text/plain
|
|||||||
utils/fpdoc/dw_xml.pp svneol=native#text/plain
|
utils/fpdoc/dw_xml.pp svneol=native#text/plain
|
||||||
utils/fpdoc/dwlinear.pp svneol=native#text/plain
|
utils/fpdoc/dwlinear.pp svneol=native#text/plain
|
||||||
utils/fpdoc/dwriter.pp svneol=native#text/plain
|
utils/fpdoc/dwriter.pp svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/basedir/readme.txt svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/basedir/sample-project.xml svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/gentest.sh svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/project/readme.txt svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/project/sample-project.xml svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/simple/html.bat svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/simple/html.sh svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/simple/readme.txt svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/simple/testunit.pp svneol=native#text/plain
|
||||||
|
utils/fpdoc/examples/simple/testunit.xml svneol=native#text/plain
|
||||||
utils/fpdoc/fpclasschart.lpi svneol=native#text/plain
|
utils/fpdoc/fpclasschart.lpi svneol=native#text/plain
|
||||||
utils/fpdoc/fpclasschart.pp svneol=native#text/plain
|
utils/fpdoc/fpclasschart.pp svneol=native#text/plain
|
||||||
utils/fpdoc/fpde/Makefile svneol=native#text/plain
|
utils/fpdoc/fpde/Makefile svneol=native#text/plain
|
||||||
@ -15744,7 +15754,6 @@ utils/fpdoc/fpdocstripper.lpi svneol=native#text/plain
|
|||||||
utils/fpdoc/fpdocstripper.pp svneol=native#text/plain
|
utils/fpdoc/fpdocstripper.pp svneol=native#text/plain
|
||||||
utils/fpdoc/fpdocxmlopts.pas svneol=native#text/plain
|
utils/fpdoc/fpdocxmlopts.pas svneol=native#text/plain
|
||||||
utils/fpdoc/fpmake.pp svneol=native#text/plain
|
utils/fpdoc/fpmake.pp svneol=native#text/plain
|
||||||
utils/fpdoc/gentest.sh svneol=native#text/plain
|
|
||||||
utils/fpdoc/images/minus.png -text svneol=unset#image/png
|
utils/fpdoc/images/minus.png -text svneol=unset#image/png
|
||||||
utils/fpdoc/images/plus.png -text svneol=unset#image/png
|
utils/fpdoc/images/plus.png -text svneol=unset#image/png
|
||||||
utils/fpdoc/intl/Makefile svneol=native#text/plain
|
utils/fpdoc/intl/Makefile svneol=native#text/plain
|
||||||
@ -15765,8 +15774,6 @@ utils/fpdoc/mkfpdocproj.pp svneol=native#text/plain
|
|||||||
utils/fpdoc/plusimage.inc svneol=native#text/plain
|
utils/fpdoc/plusimage.inc svneol=native#text/plain
|
||||||
utils/fpdoc/sample-project.xml svneol=native#text/plain
|
utils/fpdoc/sample-project.xml svneol=native#text/plain
|
||||||
utils/fpdoc/sh_pas.pp svneol=native#text/plain
|
utils/fpdoc/sh_pas.pp svneol=native#text/plain
|
||||||
utils/fpdoc/testunit.pp svneol=native#text/plain
|
|
||||||
utils/fpdoc/testunit.xml svneol=native#text/plain
|
|
||||||
utils/fpdoc/unitdiff.pp svneol=native#text/plain
|
utils/fpdoc/unitdiff.pp svneol=native#text/plain
|
||||||
utils/fpgmake/fpgmake.pp svneol=native#text/plain
|
utils/fpgmake/fpgmake.pp svneol=native#text/plain
|
||||||
utils/fpgmake/fpmake.cft svneol=native#text/plain
|
utils/fpgmake/fpmake.cft svneol=native#text/plain
|
||||||
|
11
utils/fpdoc/examples/basedir/readme.txt
Normal file
11
utils/fpdoc/examples/basedir/readme.txt
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
This directory demonstrates the use of a fpdoc project file.
|
||||||
|
It uses the files in the examples/simple directory.
|
||||||
|
|
||||||
|
The project file contains the names of the files without paths.
|
||||||
|
That means that fpdoc must be executed from this directory,
|
||||||
|
supplying the paths to the input and description files
|
||||||
|
|
||||||
|
fpdoc --project=sample-project.xml --base-input-dir=../simple --base-descr-dir=../simple
|
||||||
|
|
||||||
|
The docs will be written to a subdirectory doc.
|
||||||
|
This directory can be deleted if it is no longer necessary.
|
29
utils/fpdoc/examples/basedir/sample-project.xml
Normal file
29
utils/fpdoc/examples/basedir/sample-project.xml
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
<docproject>
|
||||||
|
<packages>
|
||||||
|
<!-- Multiple packages can be entered.
|
||||||
|
If only one is specified, it is selected.
|
||||||
|
"name" is a mandatory attribute
|
||||||
|
a "units" tag is required, and a "descriptions" tag as well
|
||||||
|
-->
|
||||||
|
<package name="fpdocsample" output="doc" contentfile="fpdocsample.cnt">
|
||||||
|
<!-- All input files, one "unit" tag per unit -->
|
||||||
|
<units>
|
||||||
|
<!-- "file" is a mandatory attribute, "options" is not mandatory -->
|
||||||
|
<unit file="testunit.pp" options="-S2"/>
|
||||||
|
</units>
|
||||||
|
<descriptions>
|
||||||
|
<!-- Description files here. One "description" tag per file.
|
||||||
|
"file" is the only mandatory attribute -->
|
||||||
|
<description file="testunit.xml"/>
|
||||||
|
</descriptions>
|
||||||
|
</package>
|
||||||
|
</packages>
|
||||||
|
<options>
|
||||||
|
<!-- All command-line options can be specified here with the same name
|
||||||
|
and value as on the actual command-line. Boolean options must have
|
||||||
|
a value of 'true', '1' or 'yes' -->
|
||||||
|
<option name="format" value="html"/>
|
||||||
|
<option name="hide-protected" value="true"/>
|
||||||
|
<option name="footer-date" value="yyyy-mm-dd"/>
|
||||||
|
</options>
|
||||||
|
</docproject>
|
10
utils/fpdoc/examples/project/readme.txt
Normal file
10
utils/fpdoc/examples/project/readme.txt
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
This directory demonstrates the use of a fpdoc project file.
|
||||||
|
It uses the files in the examples/simple directory.
|
||||||
|
|
||||||
|
The project file contains the names of the files with relative paths.
|
||||||
|
That means that fpdoc must be executed from this directory:
|
||||||
|
|
||||||
|
fpdoc --project=sample-project.xml
|
||||||
|
|
||||||
|
The docs will be written to a subdirectory doc.
|
||||||
|
This directory can be deleted if it is no longer necessary.
|
29
utils/fpdoc/examples/project/sample-project.xml
Normal file
29
utils/fpdoc/examples/project/sample-project.xml
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
<docproject>
|
||||||
|
<packages>
|
||||||
|
<!-- Multiple packages can be entered.
|
||||||
|
If only one is specified, it is selected.
|
||||||
|
"name" is a mandatory attribute
|
||||||
|
a "units" tag is required, and a "descriptions" tag as well
|
||||||
|
-->
|
||||||
|
<package name="fpdocsample" output="doc" contentfile="fpdocsample.cnt">
|
||||||
|
<!-- All input files, one "unit" tag per unit -->
|
||||||
|
<units>
|
||||||
|
<!-- "file" is a mandatory attribute, "options" is not mandatory -->
|
||||||
|
<unit file="../simple/testunit.pp" options="-S2"/>
|
||||||
|
</units>
|
||||||
|
<descriptions>
|
||||||
|
<!-- Description files here. One "description" tag per file.
|
||||||
|
"file" is the only mandatory attribute -->
|
||||||
|
<description file="../simple/testunit.xml"/>
|
||||||
|
</descriptions>
|
||||||
|
</package>
|
||||||
|
</packages>
|
||||||
|
<options>
|
||||||
|
<!-- All command-line options can be specified here with the same name
|
||||||
|
and value as on the actual command-line. Boolean options must have
|
||||||
|
a value of 'true', '1' or 'yes' -->
|
||||||
|
<option name="format" value="html"/>
|
||||||
|
<option name="hide-protected" value="true"/>
|
||||||
|
<option name="footer-date" value="yyyy-mm-dd"/>
|
||||||
|
</options>
|
||||||
|
</docproject>
|
2
utils/fpdoc/examples/simple/html.bat
Normal file
2
utils/fpdoc/examples/simple/html.bat
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
rem Command line to create html docs.
|
||||||
|
fpdoc --package=fpdocsample --output=doc --format=html --input="-S2 testunit.pp" --descr=testunit.xml
|
2
utils/fpdoc/examples/simple/html.sh
Normal file
2
utils/fpdoc/examples/simple/html.sh
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
fpdoc --package=fpdocsample --output=doc --format=html --input='-S2 testunit.pp' --descr=testunit.xml
|
9
utils/fpdoc/examples/simple/readme.txt
Normal file
9
utils/fpdoc/examples/simple/readme.txt
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
This directory contains the files for the projects.
|
||||||
|
|
||||||
|
You can create HTML documentation using just the command-line by executing the
|
||||||
|
following command in this directory:
|
||||||
|
|
||||||
|
(on 1 line)
|
||||||
|
fpdoc --package=fpdocsample --output=doc --format=html --input='-S2 testunit.pp' --descr=testunit.xml
|
||||||
|
|
||||||
|
Sample command-lines can be found in html.sh and html.bat
|
Loading…
Reference in New Issue
Block a user