(Java Sources Browser)

1. About
2. Description
3. Installation
4. JSBrowser commands
• InitJSBrowser
• Start
• Stop
• Generate the java documentation
• Configuration
5. Questions and known problems
6. Versions history
7. Registration and licensing

To initialize JSBrowser server:

• On Windows: Execute "InitJSBrowser.bat"
• On Unix/Linux: Execute "InitJSBrowser.sh"

This command must be executed just after the installation, and if the Java(TM) 2 SDK is no more in the same location.

To start JSBrowser server:

• On Windows: Execute "start.bat" or the "start" shortcut that has been installed in the "Start/Program/JSBrowser v2.2" menu
• On Unix/Linux: Execute "start.sh"

To stop JSBrowser server:

• On Windows: Execute "stop.bat" or the "stop" shortcut that has been installed in the "Start/Program/JSBrowser v2.2" menu
• On Unix/Linux: Execute "stop.sh"

To generate the java documentation:

• On Windows: Execute "GenJavadoc.bat" or the "Generate Javadoc" shortcut that has been installed in the "Start/Program/JSBrowser v2.2" menu
• On Unix/Linux: Execute "GenJavadoc.sh"

To configure JSBrowser:

• On Windows: Execute "config.bat" or the "config" shortcut that has been installed in the "Start/Program/JSBrowser v2.2" menu
• On Unix/Linux: Execute "config.sh"

Options:

• "Create a new project" button:
  This button allows creating a new project. A project represents a version of your program. For example, you can have two projects: "My Program version 1.0" and "My Program version 2.0"
  You can add in your project the jdk classes to have a better navigation through the classes.
  In the description field, you can enter a description of your project, this description can include some html tag.
  Example: <b><a href="http://MyProject.com">My project V1.0</a></b> will display: My project V1.0

• "Package directories or jar files" list:
  This list contains the packages that you will browse with JSBrowser. When you change this list, do not forget to regenerate the javadoc (see "Generate the java documentation").
  
  • "Add Directory..." button
  
  Select the top directory of your project and JSBrowser will scan sub-directories to find java sources to browse
  
  JSBrowser can manage packages that are dispatched in several directories (Only available with the professional version). This can be useful if your project is split in different directories and each developer works on a sub-package.
  
  Example with 2 programs A and B:
  

  Each program has its specific classes, and directories. But each program contains common classes that are put in an util package.
  
  Program A contains classes of the following packages in the /src/programA directory:
      pack1.pack2.program.A
    pack1.pack2.program.util
  
  Program B contains classes of the following packages in the /src/programB directory:
      pack1.pack2.program.B
    pack1.pack2.program.util
  
  If in your configuration your source directories list contains:
      /src/programA/pack1
    /src/programB/pack1
  then in the JSBrowser you will have the 3 packages:
      pack1.pack2.program.A => from /src/programA directory
    pack1.pack2.program.B => from /src/programB directory
    pack1.pack2.program.util => contains classes from the /src/programA and /src/programB directories.
  
  

  • "Add File..." button
  
  You can add jar or zip file in the list. In this case java sources containing by your file will be available in JSBrowser.
  Warning: Your zip or jar files must contain java source files (.java) and not only the compiled class files (.class).
  
  
• "External javadoc directories" list:
  If you have already a directory containing the java documentation of your java sources, add it in this list. So when JSBrowser will generate the javadoc it will use this directory instead of create it once again.
  Give the directory containing the "package-list" file.
  Tip: Add the Java(TM) 2 SDK documentation directory since it represents more than 100Mo and is very long to generate.