fpc/utils/fpdoc
michael d42c334de9 * Fix memory leak, patch from Andrey Sobol
git-svn-id: trunk@48025 -
2021-01-04 09:13:08 +00:00
..
examples * Fix hints and warnings (parameter not used disabled on purpose) 2019-01-20 11:10:50 +00:00
fpde Regenerate all Makefile's, and update utils/fpcm/fpcmake.inc and utils/fpcm/revision.inc after commit 47483 2020-11-20 14:03:57 +00:00
images
intl
COPYING.txt
css.inc
dglobals.pp * Refactor HTML engine so it can more easily be extended 2021-01-03 14:08:48 +00:00
dw_basehtml.pp * Forgot to commit 2021-01-03 15:30:41 +00:00
dw_basemd.pp * Refactor HTML engine so it can more easily be extended 2021-01-03 14:08:48 +00:00
dw_chm.pp * still add files that start with ., just not to FTS 2021-01-03 15:21:43 +00:00
dw_dxml.pp
dw_html.pp * Refactor HTML engine so it can more easily be extended 2021-01-03 14:08:48 +00:00
dw_ipflin.pas * Fix hints and warnings (parameter not used disabled on purpose) 2019-01-20 11:10:50 +00:00
dw_latex.pp * add underline support. Patch by Oleg, mantis #35946 2019-09-07 15:16:13 +00:00
dw_linrtf.pp * add underline support. Patch by Oleg, mantis #35946 2019-09-07 15:16:13 +00:00
dw_lintmpl.pp
dw_man.pp * add underline support. Patch by Oleg, mantis #35946 2019-09-07 15:16:13 +00:00
dw_markdown.pp * Refactor HTML engine so it can more easily be extended 2021-01-03 14:08:48 +00:00
dw_template.pp
dw_txt.pp * Partially resolved ID 38141 : better handling of class hierarchy and cross-package links 2020-12-07 11:55:51 +00:00
dw_xml.pp * Fix hints and warnings (parameter not used disabled on purpose) 2019-01-20 11:10:50 +00:00
dwlinear.pp * Fix hints and warnings (parameter not used disabled on purpose) 2019-01-20 11:10:50 +00:00
dwriter.pp * Fix memory leak, patch from Andrey Sobol 2021-01-04 09:13:08 +00:00
fpclasschart.lpi * Fix hints and warnings (parameter not used disabled on purpose) 2019-01-20 11:10:50 +00:00
fpclasschart.pp * Partially resolved ID 38141 : better handling of class hierarchy and cross-package links 2020-12-07 11:55:51 +00:00
fpdoc.css
fpdoc.lpi * Refactor HTML engine so it can more easily be extended 2021-01-03 14:08:48 +00:00
fpdoc.pp * Refactor HTML engine so it can more easily be extended 2021-01-03 14:08:48 +00:00
fpdocclasstree.pp * get rid of some warnings 2021-01-03 14:08:02 +00:00
fpdocproj.pas * Endianness 2020-12-09 23:33:53 +00:00
fpdocstripper.lpi
fpdocstripper.pp
fpdocxmlopts.pas * Remove debug file writing 2019-05-30 16:24:20 +00:00
fpmake.pp * Markdown support for fpdoc 2021-01-02 14:28:45 +00:00
Makefile Regenerate all Makefile's, and update utils/fpcm/fpcmake.inc and utils/fpcm/revision.inc after commit 47483 2020-11-20 14:03:57 +00:00
Makefile.fpc * trunk to 3.3.1 2018-08-18 15:47:44 +00:00
Makefile.fpc.fpcmake * trunk to 3.3.1 2018-08-18 15:47:44 +00:00
makeskel.lpi * Do not save so much session info 2019-01-20 17:57:27 +00:00
makeskel.pp * Add FPC define, check for unit for short description 2019-08-24 09:51:13 +00:00
mgrfpdocproj.pp
minusimage.inc
mkfpdoc.pp * Endianness 2020-12-09 23:33:53 +00: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