Summary

Provide a new option for the Standard Doclet to allow the user to add additional JavaScript files to the generated documentation.

Problem

Documentation generated by the Standard Doclet contains two JavaScript files that implement standard functionality such as table tabs and search. Users may want to provide additional functionality in their documentation that requires additional script files. There is currently no way to do this in javadoc.

Solution

Add a new command-line option to the Standard Doclet to provide additional JavaScript recources to be included in the generated documentation. The doclet will copy the specified script files to the output directory and add HTML elements linking the script files to all appropriate generated HTML files.

Specification

The following option is added to the Standard Doclet:

--add-script <file>
              Add a script file to the generated documentation

The option causes the specified file to be copied to the generated documentation and a <script> element to be added to every generated HTML page (with the exception of pages that serve only to redirect to other pages).

If the specified file does not exist or cannot be read an error is generated.

The option can be used more than once to specify multiple scripts to be included in the documentation.