fpc/utils/fpdoc
marco e6277f6633 o commit patch from Mantis 17191:
* Patch with new linear based IPF writer
    * patch for Interfaces Overview in all Linear writers
    * patch with new Linear Writer specific parameter to control
      if linked documentation should be duplicated or not.
      new parameter is: --duplinkeddoc
      Default is that linked docs are not duplicated.
    * patch for fixing minor spelling mistakes in fpdoc
    * patch to not create a section Errors if there isn't actually
      any specific documentation for errors. makeskel generates error
      nodes but most don't have any items. This caused an Errors title
      in the docs, but with no content.
    * patch to fix SeeAlso section in Linear writer. It never output
      the custom text, but always the node link as text.
    * new features for linear writer that could be overridden in
      descendants.
      - marked some protected methods as virtual so it can be overridden
        in descendants for customization.
      - new section for listing Types found in a unit. Default does nothing,
        except in IPF writer.
      - new section for listing Variables found in a unit. Default does
        nothing, except in IPF writer.
      - new section for listing Constants found in a unit. Default does
        nothing, except in IPF writer.

git-svn-id: trunk@15849 -
2010-08-19 04:26:26 +00:00
..
fpde * Makefiles version 2.5.1 2009-08-13 21:21:28 +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
dglobals.pp o commit patch from Mantis 17191: 2010-08-19 04:26:26 +00:00
dw_dxml.pp * (reworked) patch from m. spiller to add turbo delphi doc output format 2009-10-23 10:16:57 +00:00
dw_html.pp * while searching for ancestor classes/interfaces after all USES unit 2010-08-13 22:34:42 +00:00
dw_htmlchm.inc * Fixes compilation problem 2009-10-10 19:23:30 +00:00
dw_ipflin.pas o commit patch from Mantis 17191: 2010-08-19 04:26:26 +00:00
dw_latex.pp o commit patch from Mantis 17191: 2010-08-19 04:26:26 +00:00
dw_linrtf.pp o commit patch from Mantis 17191: 2010-08-19 04:26:26 +00:00
dw_lintmpl.pp * log and id tags removed 2005-05-21 09:42:41 +00:00
dw_man.pp + Check for empty example file name 2006-08-20 09:44:43 +00:00
dw_template.pp + Check for empty example file name 2006-08-20 09:44:43 +00:00
dw_txt.pp o commit patch from Mantis 17191: 2010-08-19 04:26:26 +00:00
dw_xml.pp * Patch from m. spiller to actually output xml 2009-10-23 10:11:50 +00:00
dwlinear.pp o commit patch from Mantis 17191: 2010-08-19 04:26:26 +00:00
dwriter.pp * Added support for version tag (same level as errors or seealso tags 2010-03-13 16:03:52 +00:00
fpclasschart.lpi * Removed session info 2008-08-25 15:42:14 +00:00
fpclasschart.pp * show usage if no parameters 2009-02-18 17:44:02 +00:00
fpdoc.css * Patch from Nikolay Nikolov to fix compliance mode rendering 2010-05-30 13:44:20 +00:00
fpdoc.lpi * Added support for the url tag to include arbitrary links 2009-11-13 15:58:45 +00:00
fpdoc.pp o commit patch from Mantis 17191: 2010-08-19 04:26:26 +00:00
Makefile * Update Makefiles 2009-12-10 08:26:29 +00:00
Makefile.fpc * added some non-cleaned units to be cleaned 2009-10-10 18:10:24 +00:00
makeskel.lpi * Created lazarus project file for easier editing 2008-08-25 09:52:14 +00:00
makeskel.pp * With --help, do not check for package name 2009-04-14 12:24:01 +00:00
README.txt * added .txt extensions to all README, TODO and COPYING files 2009-02-28 17:34:08 +00:00
sh_pas.pp * log and id tags removed 2005-05-21 09:42:41 +00:00
testunit.pp * Test unit for testing purposes 2010-03-13 16:04:19 +00:00
testunit.xml * Test unit for testing purposes 2010-03-13 16:04:19 +00:00
unitdiff.pp * log and id tags removed 2005-05-21 09:42:41 +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

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