(Java Sources Browser)

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

To start JSBrowser server:

• On Windows: Execute "JSBrowser.exe" or the "JSBrowser" shortcut that has been installed in the "Start/Program/JSBrowser v3.0" menu
• On Unix/Linux: Execute "JSBrowser.sh -start"

To stop JSBrowser server:

• On Windows: Select "Exit" in the JSBrowser Console
• On Unix/Linux: Execute "JSBrowser.sh -stop"

To generate the java documentation:

• On Windows: Click on the "Generate Javadoc" button in the JSBrowser Console
• On Unix/Linux: Execute "GenJavadoc.sh"

To configure JSBrowser: Start JSBrowser. Click on the "JSBrowser configuration" link.


Project options:

• Name:
  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.
  

• Description:
  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

• Path:
  This list contains the packages that you will browse with JSBrowser. In this list you can add "Java source directories", "Java sources bundles", "Javadoc directories", and/or "Javadoc file bundles"
  
  Java source directories:

  Add the top directory of your project and JSBrowser will scan sub-directories to find java sources to browse and javadoc
  
  JSBrowser can manage packages that are dispatched in several directories. 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.
  

  Java source bundles:

  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).
  

  Javadoc directories:

  If you have already a directory containing the java documentation of your java sources, add it in this list. Because if you use the javadoc generation command, when JSBrowser will generate the javadoc it will use this directory instead of create a new one.
  Tip: Add the Java(TM) 2 SDK documentation directory since it represents more than 100Mo and is very long to generate. (see "Generate the java documentation").
  

  Javadoc file bundles:

  You can add directly zip or jar files that contain javadoc files.
  

  
  When you change this list, do not forget to regenerate the javadoc (see "Generate the java documentation") else the documentation will be generated on the fly (this will consume more time and CPU).