JavadocWizard (JDW) v1.6 for JBuilder 10 (ID #20976)

KyrSoft

JavadocWizard v.1.6 readme.txt - 10/21/2003
------------------------------------------------------------------------------
(Build for JBuilder 10 with jdk 1.4.2 under Windows 2000/SP4)

COPYRIGHT

Copyrighted (c) 2000-2003 by KyrSoft, All rights reserved

NOTICE

The use of this software is governed by the terms in the file License.html,
which is included in this distribution. You must read this and agree to these
terms before using or distributing this shareware software. The use and handling
of the registration is described in the file Registration.html, which is also
included in this distribution.

The burnt in demo license of this Javadoc Wizard 1.6 version will expire at the
31. July 2004.

DESCRIPTION

JavadocWizard is an OpenTool that enables the javadoc processing directly
from inside of the JBuilder IDE. It allows also now the previewing of HTML
files in a default external WebBrowser, like InternetExplorer or Netscape!

WARRANTY AND TERMS OF USE

This software is copyrighted (c) 2000-2003 by KyrSoft. All rights reserved.
This shareware software is provided "as is" with no warranty of any kind.
KyrSoft take no responsibility for any damages that may result from using it.
So it's usage is on your own risk.

FILES

The software is packed inside a JavadocWizard.zip file.
The following files should be inside the archive:
- (Readme.html) a HTML readme file, please read this before you install
- (Installation.pdf) a PDF file with installation instructions
- (javadocwizard.jar) a JAR file with compiled classes
- (javadocwizard.pdf) the javadocwizard manual as a PDF file
- (doclets-tut.zip) a small JDW doclets tutorial
- (License.pdf) a PDF file with license notes
- (Registration.pdf) a PDF file with registration handling notes
- (Orderform-us.txt) a text file with a registration form
- (Orderform-de.txt) a german text file with a registration form

INSTALLATION

Unpack the JavadocWizard.zip archive and put the following files into the
indicated places:

- the JAR file (javadocwizard.jar) into the /lib/ext directory
- the ZIP file (doclets-tut.zip) where you want, it contains a small JDW
doclet tutorial project

Restart JBuilder. There should be a new item under the "Wizards" menu named
"Javadoc Wizard...". You should now be able to use this JavadocWizard menu
entry.

UNINSTALL

To uninstall the Javadoc Wizard just delete the JAR file from the ../lib/ext
directory under your JBuilder installation directory. Then restart JBuilder.

USAGE

Usage of this "JavadocWizard" should be straight forward for those who
know the old JB3 Javadoc Wizard. People who don't know it, should take
a look into the JBuilder 10 online help parts of the JDK 1.4.2, which
describe the standard Sun "javadoc" commandline tool. This "JavadocWizard"
OpenTool is just a GUI frontend to the underlaying JDK 1.4.2 commandline
"javadoc" tool supplied by Sun. Simplified, all it does is to collect your
settings and adjustments and then to pass these to an external started
"javadoc" process. NOTE, that the initial "standard option" settings you
make inside the JavadocWizard will be saved into a "jdw" directory of your
actual JBuilder project directory. The corresponding "advanced option"
settings will be saved into *another* "javadoc.properties" file inside
your actual JBuilder "jdw" project directory!

IMPORTANT: for the JavadocWizard to work, you must always have defined an
own package structure in your projects, otherwise the JavadocWizard won't
process your projects. This is due to the way how the underlaying JDKs
javadoc commandline tool works!

DOCUMENTATION

The Javadoc Wizard documentation is available from the wizard pages by
pressing the Help button. To read the documentation without running JBuilder,
you may extract the documentation from the file jdwizarddoc.jar, which is
included in this distribution.

If you choose to extract the documentation (this is not necessary since there
is a javadocwizard.pdf file inside this distribution), you will
probably want to create a separate directory for these files. Assuming that
you have the distribution files unpacked into the current directory, you could
use the following commands:

jar xf javadocwizard.jar help
cd help

When you have done this, open the file javadocwizard.html using a web browser.

JavadocWizard (JDW) v1.6 for JBuilder 10 home page