fpc/utils/fpdoc
2024-02-13 09:07:50 +01:00
..
examples
fpde human68k: regenerated Makefiles 2023-11-30 23:43:27 +00:00
images
intl * patch from Debian package by Abou Al Montacir: Change path of localization fies to fit Debian standard, http://bugs.debian.org/73368 2022-03-04 22:48:16 +01:00
.gitignore fpdoc: gitignore linux binary 2021-11-03 21:57:32 +01:00
COPYING.txt
css.inc
dglobals.pp * Added some debugging aids 2023-01-17 14:32:38 +01:00
dw_basehtml.pp * PChar -> PAnsiChar 2023-07-24 14:55:41 +02:00
dw_basemd.pp * PChar -> PAnsiChar 2023-07-24 14:55:41 +02:00
dw_chm.pp fpdoc: fixed ElementType, issue 39887 2022-09-10 16:22:11 +02:00
dw_dxml.pp
dw_html.pp * PChar -> PAnsiChar 2023-07-24 14:55:41 +02:00
dw_ipflin.pas * PChar -> PAnsiChar 2023-07-24 14:55:41 +02:00
dw_latex.pp * PChar -> PAnsiChar 2023-07-24 14:55:41 +02:00
dw_linrtf.pp * PChar -> PAnsiChar 2023-07-24 14:55:41 +02:00
dw_lintmpl.pp
dw_man.pp
dw_markdown.pp * PChar -> PAnsiChar 2023-07-24 14:55:41 +02:00
dw_template.pp
dw_txt.pp
dw_xml.pp
dwlinear.pp * PChar -> PAnsiChar 2023-07-24 14:55:41 +02:00
dwriter.pp * Added some debugging aids 2023-01-17 14:32:38 +01:00
fpclasschart.lpi
fpclasschart.pp
fpdoc.css
fpdoc.lpi
fpdoc.pp * Correct exception handling 2023-01-16 14:02:15 +01:00
fpdocclasstree.pp * Patch from Andrey Sobol to improve display of specialized types 2021-01-23 14:29:56 +00:00
fpdocproj.pas
fpdocstripper.lpi
fpdocstripper.pp
fpdocstrs.pp * --example-dir support 2021-08-09 16:46:30 +02:00
fpdocxmlopts.pas
fpmake.pp human68k: fpmake changes, disable everything that cannot be built currently 2023-11-30 23:43:27 +00:00
Makefile * Use common makefile 2023-07-25 15:14:16 +02:00
Makefile.fpc.fpcmake
makeskel.lpi
makeskel.pp
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 * Guard against empty source, fixes build of docs 2024-02-13 09:07:50 +01:00
unitdiff.pp * Disable result, explicit list cmmand-line argument 2023-06-05 11:43:07 +02: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