fpc/utils/fpdoc
Michaël Van Canneyt 848bd3e0c0 * Fix compation
2021-09-01 09:29:50 +02:00
..
examples
fpde * set EXEEXT to .wasm for the WASI target in fpcmake 2021-06-24 00:16:00 +00:00
images
intl
COPYING.txt
css.inc
dglobals.pp * --example-dir support 2021-08-09 16:46:30 +02:00
dw_basehtml.pp * Patch from Andrey Sobol to improve display of specialized types 2021-01-23 14:29:56 +00:00
dw_basemd.pp * Some restructuring by Andrey, add fallback link 2021-01-18 15:27:58 +00:00
dw_chm.pp * Specify mode 2021-02-01 13:16:20 +00:00
dw_dxml.pp * Some restructuring by Andrey, add fallback link 2021-01-18 15:27:58 +00:00
dw_html.pp * Fix compation 2021-09-01 09:29:50 +02:00
dw_ipflin.pas * Patches from Andrey Sobol, more control over warnings, improve class tree and resolving 2021-01-16 15:05:44 +00:00
dw_latex.pp * Some restructuring by Andrey, add fallback link 2021-01-18 15:27:58 +00:00
dw_linrtf.pp * Some restructuring by Andrey, add fallback link 2021-01-18 15:27:58 +00:00
dw_lintmpl.pp
dw_man.pp * Some restructuring by Andrey, add fallback link 2021-01-18 15:27:58 +00:00
dw_markdown.pp * Some small improvements from Andrey Sobol: better specialization declaration in markdown, write more detailed end log 2021-02-01 13:15:05 +00:00
dw_template.pp
dw_txt.pp * Some restructuring by Andrey, add fallback link 2021-01-18 15:27:58 +00:00
dw_xml.pp * Some restructuring by Andrey, add fallback link 2021-01-18 15:27:58 +00:00
dwlinear.pp * Some restructuring by Andrey, add fallback link 2021-01-18 15:27:58 +00:00
dwriter.pp * Remove debug statement 2021-03-19 14:39:20 +00:00
fpclasschart.lpi
fpclasschart.pp * Patches from Andrey Sobol, more control over warnings, improve class tree and resolving 2021-01-16 15:05:44 +00:00
fpdoc.css
fpdoc.lpi * Allow single page mode for multi-page writers 2021-01-23 11:42:21 +00:00
fpdoc.pp * --example-dir support 2021-08-09 16:46:30 +02:00
fpdocclasstree.pp * Patch from Andrey Sobol to improve display of specialized types 2021-01-23 14:29:56 +00:00
fpdocproj.pas * Some restructuring by Andrey, add fallback link 2021-01-18 15:27:58 +00:00
fpdocstripper.lpi
fpdocstripper.pp
fpdocstrs.pp * --example-dir support 2021-08-09 16:46:30 +02:00
fpdocxmlopts.pas * Fix compilation 2021-01-16 16:55:48 +00:00
fpmake.pp Disable most utils for SinclairQL for now 2021-04-09 20:15:48 +00:00
Makefile * set EXEEXT to .wasm for the WASI target in fpcmake 2021-06-24 00:16:00 +00:00
Makefile.fpc
Makefile.fpc.fpcmake
makeskel.lpi
makeskel.pp * Fix compilation 2021-01-16 16:55:48 +00:00
mgrfpdocproj.pp
minusimage.inc
mkfpdoc.pp * --example-dir support 2021-08-09 16:46:30 +02:00
mkfpdocproj.lpi
mkfpdocproj.pp
plusimage.inc
README.txt
sample-project.xml
sh_pas.pp
unitdiff.pp * Fix -h or --help 2020-05-01 14:11:14 +00:00

For more informations, see readme.html in the 'doc' subdirectory. There you
can also find the default CSS for the HTML output.


This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA


(the file COPYING contains the whole GNU General Public License)


Source file overview
--------------------

dglobals.pp
  * Global declarations
  * Catalogue management (internal link and description lookup tables)

dwriter.pp
  * Basic writer (output generator) class

dw_html.pp
  * HTML/XHTML output generator

dwlinear.pp
  * Abstract linear documentation generator.

dw_latex.pp
  * LaTeX output generator, based on linear documentation generator.

dw_txt.pp
  * Plain text output generator, based on linear documentation generator.

dw_xml.pp
  * 'XML struct' output generator


dw_man.pp
  * 'Unix man page' output generator

fpdoc.pp
  * Main program

fpdocstripper.lpr
fpdocstripper.lpi
  * Utility program that strips fpdoc xml files of all elements 
    that have no documentation in them. Useful before submitting
	a documentation patch as it keeps file sizes down and makes
	it clearer what exactly is documented.
  
makeskel.pp
  * Skeleton XML description file generator

dw_template.pp
  * template for implementing a new writer back-end.

dw_lintmpl.pp
  * template for implementing a new linear writer back-end.


Contributors
------------
Initial French output strings by Pierre Muller
Initial Dutch output strings by Marco van de Voort
fpdocstripper by Reinier OliSlagers