This document describes how to generate the JavaDoc for all the modules you might have checked out within one directory.
We assume that you have checked out at least one project containing Java source code. You must also have the "extras/scripts/" directory containing "javadoc-gen.sh" .
From the command line in Linux, naviagte to the directory containing the Gateway modules you have downloaded locally. Assuming (current-directory)/extras/scripts/javadoc-gen.sh is a valid path from within this directory, enter the following command:
$ bash extras/scripts/javadoc-gen.sh
Note: The script can be stored anywhere, it only matters that you run it from a path that contains at least one gateway module with Java source.
Now after a few moments the script will finish and you will be left with the following directories:
(current-directory)/javadoc/ (current-directory)/javadoc/html_doc
Navigate to the javadoc/html_doc/ and notice that a number of html files and directories have been created. Now you can load index.html or index-all.html with a web browser to view the JavaDoc pages you have just generated.
These pages are a good map/overview of the project, however more specific documentation about the function of the Gateway is provided in the developer section of this website.