A sample of javadoc command line argument file

com.myCompany.myPackage1 com.myCompany.myPackage2.mySubPackage1.mySubPackage2 src/com/myCompany/myPackage3/myClassA.java src/com/myCompany/myPackage3/myClassB.java src/com/myCompany/myPackage2/mySubPackage1/mySubPackage3/myClassC.java

Specify a package name (e.g. "com.myCompany.myPackage1") or a path to a source file (e.g. "src/com/myCompany/myPackage3/myClassA.java") per line.

More information on the javadoc "command line arguments file" (as of JDK1.3) can be found at:

Solaris: http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html Win32: http://java.sun.com/j2se/1.3/docs/tooldocs/win32/javadoc.html

Back

How to exclude some entries from the generated API document of your program (<projectDirectory>/docs/api)

Take one of the two ways:

• Method A.    Edit your source code under <projectDirectory>/<src> to make these unwanted entries temporarily private, do the previous step (target "prepare2") again, and undo the temporal changes in those modifiers.
  
  
• Method B.    Delete these unwanted entries from generated API document. To delete an entry from an index page, take the following steps:
  1. Find an index page (e.g. "index-all.html", "index-1.html") that contains the unwanted entry.
  2. Use any text editor and edit the html source, in order to delete the <DT> and <DD> tag parts of the unwanted entry. The following example explains how to delete the method actionPerformed(java.awt.event.ActionEvent) from the document:
  
  --- an excerpt from html source ---
  ...
  <DT>...
  <DD>...
  
  Instruction: delete from the next line ---->
  <DT><A HREF="com/chainkey/jchain/sa/licensee/Licensee.html#actionPerformed(java.awt.event.ActionEvent)"><B>actionPerformed(ActionEvent)</B></A> -
  Method in class com.chainkey.jchain.sa.licensee.<A HREF="com/chainkey/jchain/sa/licensee/Licensee.html">Licensee</A>
  <DD>Does something when an event is reported.
  <---- to the previous line
  
  <DT>...
  <DD>...
  ...
  

Back

How to prepare 3rd party API documents under <projectDirectory>/docs/external

Each directory (docs/external/<libN>) should contain what the destination directory of javadoc (of Nth library) would contain. The "index.html" should be found directly under docs/external/<libN>.

Copy the API document (javadoc) of the 1st library under <projectDirectory>/docs/external/<lib1>/
e.g. under /home/userA/protection/myProject1/docs/external/nameOfLibrary/

Copy the API document (javadoc) of the 2nd library under <projectDirectory>/docs/external/<lib2>/
e.g. under /home/userA/protection/myProject1/docs/external/nameOfAnotherLibrary/
...

[ Note ]

• A 3rd party library usually comes with a javadoc-generated API documents.
• The Protector doesn't support the old javadoc format of jdk1.1. It is rare, if any, that a 3rd party document is provided in this old format. To make sure, please confirm with its vendor.
• You don't have to do anything at this step, if your program doesn't depend on any external library except JDK.
• If you already have "reserved_for_<libx>" file for a library <libx> in the "external" directory, you don't have to take this step for that specific library.
  
• You can also mannually prepare those "reserved_for_<libx>" files, if the number of reserved names are not very large. The format of the file is self-explanatory (see any file in the "reserved_names" folder). Just list up names which should be regarded as reserved, and therefore should be preserved through obfuscation.
  

Back









Top

---

Copyright (c) 2002-2008 ChainKey, Inc. All rights reserved