/******************************************************************************
 ColorSafe 1.0 Beta Build Command Examples - http://www.woven-media.com/
*******************************************************************************

A Java 6 Swing application for color testing and conversions from RGB to
hexadecimal data formats and vice versa.

Copyright (C) 2008, 2009, Brent Allen Parrish <info@woven-media.com>

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

*******************************************************************************/
--------------------------------------------------------------------------------
MANIFEST.MF FILE CONTENTS 
--------------------------------------------------------------------------------
Manifest-Version: 1.0
Main-Class: com.woven_media.colorsafe.App

--------------------------------------------------------------------------------
CREATE EXECUTABLE JAR FILE COMMAND
--------------------------------------------------------------------------------
Ex.
C:\YourPath>jar cvfm colorsafe.jar MANIFEST.MF *

--------------------------------------------------------------------------------
EXECUTE JAR FILE FROM WINDOWS COMMANDLINE
--------------------------------------------------------------------------------
Ex.
C:\YourPath>java -jar colorsafe.jar

--------------------------------------------------------------------------------
EXECUTE FROM WINDOWS COMMANDLINE EXAMPLE
--------------------------------------------------------------------------------
Ex. 
C:\YourPath>java com.woven_media.colorsafe.App

--------------------------------------------------------------------------------
RECOMPILE JAVA PACKAGE WINDOWS EXAMPLE
--------------------------------------------------------------------------------
Ex.
C:\%YourPath%>javac -d C:\%YourPath% -sourcepath C:\%YourPath%\com\woven_media\colorsafe\src\About.java C:\%YourPath%\com\woven_media\colorsafe\src\*.java -Xlint:unchecked

Note: replace C:\%YourPath% to your install path!

========================================================
         BUILDING THE JAVADOC DOCUMENTATION
========================================================

The following commands will build the documentation for 
javadoc-enabled source files to the following directory
structure. (see $ javadoc -help for more options)

========================================================
           JAVADOC EXAMPLE BUILD COMMANDS
========================================================
                 
Include ALL Members Command (private fields included)

e.g.
javadoc -d ../api/private -private -windowtitle "ColorSafe 1.0 Beta - www.woven-media.com" *.java

--------------------------------------------------------

Include Protected/Public Members (Default) Command

e.g. 
javadoc -d ../api/default -windowtitle "ColorSafe 1.0 Beta - www.woven-media.com" *.java

--------------------------------------------------------
Other Options (see $ javadoc -help for more options)
--------------------------------------------------------
-stylesheetfile <path>
-sourcetab      <tablength>
-charset        <charset>   // Cross-platform viewing
-keywords       <meta>
-encoding       <name>      // Source file encoding name


COMMAND LINE ARGUMENT FILES
To shorten or simplify the javadoc command line, you can specify one or more files that themselves contain arguments to the javadoc command (except -J options). This enables you to create javadoc commands of any length on any operating system. 
An argument file can include Javadoc options, source filenames and package names in any combination, or just arguments to Javadoc options. The arguments within a file can be space-separated or newline-separated. Filenames within an argument file are relative to the current directory, not the location of the argument file. Wildcards (*) are not allowed in these lists (such as for specifying *.java). Use of the '@' character to recursively interpret files is not supported. The -J options are not supported because they are passed to the launcher, which does not support argument files. 

When executing javadoc, pass in the path and name of each argument file with the '@' leading character. When javadoc encounters an argument beginning with the character `@', it expands the contents of that file into the argument list. 


Example - Single Arg File
You could use a single argument file named "argfile" to hold all Javadoc arguments: 
  C:> javadoc @argfile

This argument file could contain the contents of both files shown in the next example. 
Example - Two Arg Files
You can create two argument files -- one for the Javadoc options and the other for the package names or source filenames: (Notice the following lists have no line-continuation characters.) 
Create a file named "options" containing: 

     -d docs-filelist 
     -use 
     -splitindex
     -windowtitle 'Java 2 Platform v1.3 API Specification'
     -doctitle 'Java<sup><font size="-2">TM</font></sup> 2 Platform v1.4 API Specification'
     -header '<b>Java 2 Platform </b><br><font size="-1">v1.4</font>'
     -bottom 'Copyright 1993-2000 Sun Microsystems, Inc. All Rights Reserved.'
     -group "Core Packages" "java.*"
     -overview \java\pubs\ws\1.3\src\share\classes\overview-core.html
     -sourcepath \java\pubs\ws\1.3\src\share\classes

Create a file named "packages" containing: 

     com.mypackage1
     com.mypackage2
     com.mypackage3

You would then run javadoc with: 
  C:> javadoc @options @packages


Example - Arg Files with Paths
The argument files can have paths, but any filenames inside the files are relative to the current working directory (not path1 or path2): 
  C:> javadoc @path1\options @path2\packages

Example - Option Arguments
Here's an example of saving just an argument to a javadoc option in an argument file. We'll use the -bottom option, since it can have a lengthy argument. You could create a file named "bottom" containing its text argument: 

'<font size="-1"><a href="http://java.sun.com/cgi-bin/bugreport.cgi">Submit a 
bug or feature</a><br><br>Java is a trademark or registered trademark of 
Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993-2000 Sun 
Microsystems, Inc. 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. 
All Rights Reserved.</font>'

Then run the Javadoc tool with: 
  C:> javadoc -bottom @bottom @packages

Or you could include the -bottom option at the start of the argument file, and then just run it as: 
  C:> javadoc @bottom @packages


