readme.txt

DelphiDoc is a program for automatic generation of documentation on a Delphi-Project. At the momen

JADD - Just Another DelphiDoc
-----------------------------


DelphiDoc is a program for automatic generation of documentation on 
a Delphi-Project. At the moment the documentation will be generated in HTML 
(HyperText Markup Language) format, in the Windows help (.hlp-files) format, 
in the LaTeX format or in PDF (Portable Document Format) with some additional
xfig-/wmf-files. Export to XMI to import it into other UML tools is also
available.
This is somehow like the famous JavaDoc, besides it can be generated in 
multiple formats and, of course, for Delphi and not Java.
Diagrams of the parsed files and classes can also be created.

For more information see the documentation (index.html) in the directory 
"Documentation".





This program is released under the GPL - the GNU General Public License - Version 3.
This means you are free to use and change this program according to that license.
A copy of this license should accompany this distribution, but you can also 
take a look at http://www.gnu.org/copyleft/gpl.html.

If you want to compile it please take a look at the file sourcecode.html.



This project is hosted at SourceForge:
Homepage: http://delphidoc.sourceforge.net/
Project-Page: http://sourceforge.net/projects/delphidoc
You can contact me, Gerold Veith, through the various SourceForge services
or if that is not applicable via e-mail to [e-mail].


This software uses the (included) TPNGImage component 
(General\PNGImage) hosted at:
Homepage: http://pngdelphi.sourceforge.net/
Project-Page: http://sourceforge.net/projects/pngdelphi

Also some units of the The Helpware Group to handle the new compiled HTML Help 
file (.chm) are used (General\HtmlHelpKit), which were found at:
http://www.helpware.net/delphi/

The UML export via XMI and the window for diagrams are inspired by
ESS-Model, also the code to automatically layout the diagrams (Sugiyama)
has been transfered from it:
Homepage: http://essmodel.sourceforge.net/
Project-Page: http://sourceforge.net/projects/essmodel

To extract separators and format character from comments perl-like 
regular expressions can be used. This is made possible by the
component TRegExpr (General\regexpr) by Andrey V. Sorokin, as found here:
http://RegExpStudio.com/TRegExpr/TRegExpr.html

This software also uses the (included) replacement memory manager FastMM
(General\FastMM) to speed it up, it is hosted at:
Homepage: http://fastmm.sourceforge.net/
Project-Page: http://sourceforge.net/projects/fastmm







I also would like to express my appreciation for some people, whose
work I used to learn something to integrate it into JADD.

First for Takeshi Kanno for creating PowerPDF, a set of components and
also a library to create PDF files
(http://www.est.hi-ho.ne.jp/takeshi_kanno/powerpdf/index.html).
Helped me a lot to understand the PDF format (with the help of the
official PDF 1.3 reference). 

Secondly Manfred Winterhoff for creating a description of the windows 
help file format (with the help of others):
http://www.geocities.com/mwinterhoff/helpfile.htm
I used his description of the format of pictures to create Structured 
Hyper-Graphics (*.shg), that can include multiple hot-spots (links).

And the third one goes to the people at http://www.helpware.net/ for 
their units to support the usage of compiled HTML Help files (.chm) in
Delphi just like the old Windows Help files (.hlp).





I hope this piece of software will be useful for you.


Best regards,
   Gerold Veith


Please take a look in the file index.html in the directory "Documentation"
for further information and on how to contact me.







JADD - Just Another DelphiDoc: Documentation from Delphi Source Code

Copyright (C) 2003-2008   Gerold Veith

DelphiDoc is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3 as
published by the Free Software Foundation.

DelphiDoc 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, see <http://www.gnu.org/licenses/>.


Additional permission under GNU GPL version 3 section 7:

In addition, as a special exception, Gerold Veith gives permission to link
the code of this program with
  * "HTML Help Kit for Delphi",
  * TPNGImage and
  * TRegExpr
(or with modified versions of them that use the same licenses), and distribute
linked combinations including the three. You must obey the GNU General Public
License in all respects for all of the code used other than that. If you
modify this program, you may extend this exception to your version, but you
are not obligated to do so. If you do not wish to do so, delete this exception
statement from your version.