Building Documentation

Click ScriptDoc to build documentation for selected scripts.

This page lets you build the scriptDoc documentation for your scripts either individually or in a folder hierarchy. This will only be of real use if you have used the ScriptDoc tags (see Documenting your Code) in your scripts.

The page displays the projects in your Active Web servlet. Click on and to navigate to the folder or file that you wish to build documentation for and then click on the name. The file or folder will have its documentation built and the display will report the build status.

To view the documentation:

  1. Start your web browser.

  2. Put http://server:port/projectpath/docs/docs_index.html in the address field substituting 'server:port' for your Active Web server name and port number and 'projectpath' for the path to the folder for which you have just built documentation.

You should use the top level folder to build the documentation as the documentation will build a web site holding all the docs for all files in the folder hierarchy.

Comment on this topic

Topic ID: 150012