paweld/fpc
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/fpc/source.git synced 2025-04-19 10:19:30 +02:00
Code Issues Packages Projects Releases Wiki Activity
566a6d289f
fpc/utils/fpdoc
History
marco dcfe1cae13 * fix 4265 cases where the index resolved a lemma that had a link= property. 
Mantis #32325
 * adds a warning for the cases that are fixed. If generation logs are saved, this makes it easy to check if new problems are related to this fix.

git-svn-id: trunk@39065 -
2018-05-20 16:59:45 +00:00
..
examples * Examples 2015-11-20 11:34:44 +00:00
fpde Regenerated Makefile's after addition of ppas and ppaslink script removal in rev 38745 2018-04-12 15:20:27 +00:00
images
intl * fix some more occured->occured 2016-12-13 12:55:32 +00:00
COPYING.txt * updated FSF address (mantis #30198, patch by Paul Gevers) 2016-10-02 12:56:59 +00:00
css.inc * Added missing tree classes 2015-11-19 08:52:39 +00:00
dglobals.pp * Allow simple preprocessing of the project file using {{macro}} substitution. Needed for e.g. variable source dirs 2016-10-22 08:12:31 +00:00
dw_dxml.pp
dw_html.pp * fix resolve* functions for filesystems with backslashes. 2018-05-20 16:03:30 +00:00
dw_htmlchm.inc * fix 4265 cases where the index resolved a lemma that had a link= property. 2018-05-20 16:59:45 +00:00
dw_ipflin.pas * Patch from Graeme Geldenhuys to implement skip attribute in linear output writers (bug ID 30741) 2016-10-22 13:37:33 +00:00
dw_latex.pp * Fix never-ending loop in splitline 2016-04-30 07:29:54 +00:00
dw_linrtf.pp * Correct documenting of advanced records 2015-07-01 19:44:47 +00:00
dw_lintmpl.pp
dw_man.pp * Fix AVs when no description nodes available 2017-02-11 10:10:59 +00:00
dw_template.pp
dw_txt.pp * Correct documenting of advanced records 2015-07-01 19:44:47 +00:00
dw_xml.pp fpdoc: cleaned up obsolete okspecialize code 2018-02-10 11:34:49 +00:00
dwlinear.pp * Patch from Graeme Geldenhuys to implement skip attribute in linear output writers (bug ID 30741) 2016-10-22 13:37:33 +00:00
dwriter.pp * spelling mistakes fpc repo part, mantis #30233 2016-06-02 20:01:09 +00:00
fpclasschart.lpi
fpclasschart.pp * spelling mistakes fpc repo part, mantis #30233 2016-06-02 20:01:09 +00:00
fpdoc.css * Added missing tree classes 2015-11-19 08:52:39 +00:00
fpdoc.lpi fcl-passrc: nicer error position on cant find unit 2017-10-18 10:33:36 +00:00
fpdoc.pp * Allow simple preprocessing of the project file using {{macro}} substitution. Needed for e.g. variable source dirs 2016-10-22 08:12:31 +00:00
fpdocclasstree.pp * Patch from Mattias Gaertner to check for name when adding elements 2015-12-26 16:01:43 +00:00
fpdocproj.pas
fpdocstripper.lpi
fpdocstripper.pp
fpdocxmlopts.pas * Allow simple preprocessing of the project file using {{macro}} substitution. Needed for e.g. variable source dirs 2016-10-22 08:12:31 +00:00
fpmake.pp
Makefile Regenerated Makefile's after addition of ppas and ppaslink script removal in rev 38745 2018-04-12 15:20:27 +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
makeskel.lpi * Reverted revision 30575 (forgor -depth=immediate 2015-04-13 19:44:51 +00:00
makeskel.pp * Better detection of effective visibility of an element 2016-10-09 11:25:58 +00:00
mgrfpdocproj.pp
minusimage.inc
mkfpdoc.pp * More uniform error message 2017-08-16 08:47:49 +00:00
mkfpdocproj.lpi
mkfpdocproj.pp
plusimage.inc
README.txt * updated FSF address (mantis #30198, patch by Paul Gevers) 2016-10-02 12:56:59 +00:00
sample-project.xml
sh_pas.pp
unitdiff.pp * spelling mistakes fpc repo part, mantis #30233 2016-06-02 20:01:09 +00:00

README.txt 

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