fpc/utils/fpdoc
michael a192c54e7d * Basedir support
git-svn-id: trunk@32374 -
2015-11-20 11:26:58 +00:00
..
fpde * updated all the remaining makefiles that 'fpcmake -r' missed 2015-09-05 11:21:36 +00:00
images * Forgot to commit images 2012-12-20 17:16:17 +00:00
intl Slovak translation from Dusan Halicky 2008-05-28 20:17:02 +00:00
COPYING.txt * added .txt extensions to all README, TODO and COPYING files 2009-02-28 17:34:08 +00:00
css.inc * Added missing tree classes 2015-11-19 08:52:39 +00:00
dglobals.pp * Basedir support 2015-11-20 11:26:58 +00:00
dw_dxml.pp * emergency fix for breakage (TPasResString.value was still used. Changed to getdeclaration for now) 2012-01-08 00:46:57 +00:00
dw_html.pp * Basedir support 2015-11-20 11:26:58 +00:00
dw_htmlchm.inc * Various small changes. LCL compiles again, but is 10% smaller. 2013-04-20 15:31:56 +00:00
dw_ipflin.pas * Correct documenting of advanced records 2015-07-01 19:44:47 +00:00
dw_latex.pp * Correct documenting of advanced records 2015-07-01 19:44:47 +00:00
dw_linrtf.pp * Correct documenting of advanced records 2015-07-01 19:44:47 +00:00
dw_lintmpl.pp * Patch from Hans-Peter Diettrich to extend and append filenameextension (bug 21101) 2012-01-16 09:03:05 +00:00
dw_man.pp * Correct documenting of advanced records 2015-07-01 19:44:47 +00:00
dw_template.pp * Patch from Hans-Peter Diettrich to extend and append filenameextension (bug 21101) 2012-01-16 09:03:05 +00:00
dw_txt.pp * Correct documenting of advanced records 2015-07-01 19:44:47 +00:00
dw_xml.pp * Patch from Reinier Olislaghers - some cosmetic changes (Bug ID 23506) 2012-12-18 11:06:01 +00:00
dwlinear.pp * Correct documenting of advanced records 2015-07-01 19:44:47 +00:00
dwriter.pp * fix for shortdescrs. Refmodule was unassigned if the target of the shortdescr was not a module. 2013-04-21 17:39:48 +00:00
fpclasschart.lpi * Added ability to create class chart 2012-12-20 15:00:10 +00:00
fpclasschart.pp * Fix working of fpdocclasstree in case of multiple files 2015-08-22 13:49:25 +00:00
fpdoc.css * Added missing tree classes 2015-11-19 08:52:39 +00:00
fpdoc.lpi * Correct documenting of advanced records 2015-07-01 19:44:47 +00:00
fpdoc.pp * Basedir support 2015-11-20 11:26:58 +00:00
fpdocclasstree.pp * Fix working of fpdocclasstree in case of multiple files 2015-08-22 13:49:25 +00:00
fpdocproj.pas * Patch from Reinier Olislaghers - some cosmetic changes (Bug ID 23506) 2012-12-18 11:06:01 +00:00
fpdocstripper.lpi * modified Docstripper by Reinier Olislagers (bug 23988) 2013-04-07 08:49:03 +00:00
fpdocstripper.pp * modified Docstripper by Reinier Olislagers (bug 23988) 2013-04-07 08:49:03 +00:00
fpdocxmlopts.pas * Added functionality to add (and show) notes 2012-02-11 09:58:13 +00:00
fpmake.pp * No need to install resource-files from binaries, those are 2015-01-05 11:46:42 +00:00
gentest.sh * Improved testunit coverage 2015-07-26 08:31:28 +00:00
Makefile * updated all the remaining makefiles that 'fpcmake -r' missed 2015-09-05 11:21:36 +00:00
Makefile.fpc * Filter the Makefile's unit searchpaths from the fpmake command line. 2015-08-12 19:15:14 +00:00
Makefile.fpc.fpcmake * version updated to 3.1.1 2015-01-04 21:09:04 +00:00
makeskel.lpi * Reverted revision 30575 (forgor -depth=immediate 2015-04-13 19:44:51 +00:00
makeskel.pp * Resolve operators at the end. The name is corrected after the node is created 2015-07-26 08:09:56 +00:00
mgrfpdocproj.pp * Save/load package imports to/from package description file 2011-12-05 19:30:22 +00:00
minusimage.inc * Added ability to create class chart 2012-12-20 15:00:10 +00:00
mkfpdoc.pp * Basedir support 2015-11-20 11:26:58 +00:00
mkfpdocproj.lpi * Some fixes after first test round 2011-12-03 16:46:15 +00:00
mkfpdocproj.pp * Print usage message 2011-12-07 21:08:20 +00:00
plusimage.inc * Added ability to create class chart 2012-12-20 15:00:10 +00:00
README.txt * modified Docstripper by Reinier Olislagers (bug 23988) 2013-04-07 08:49:03 +00:00
sample-project.xml * Added support for project file 2011-01-05 22:19:53 +00:00
sh_pas.pp
testunit.pp * Improved testunit coverage 2015-07-26 08:31:28 +00:00
testunit.xml * Improved testunit coverage 2015-07-26 08:31:28 +00:00
unitdiff.pp * Patch from Stephane Aulery to ease compilation, adding $MODE and $H+ (Bug ID 27987) 2015-04-28 06:52:37 +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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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