Contents
Info
Bugs
Docs
Source
Email
Download
Developer

Design
Contents
Overview
Developer
Programmer
User

Automated Standards

In order to facilitate AutoRad and the GJT website, developers' packages are required to meet a set of standards.
  • No files are allowed at the top levels.
    All files must be located at the package level and lower. This is required to avoid name space collisions.
  • Documentation is located in a specified directory.
    In order to accomodate the build process, as well as allow for automated maintenance of online documenation, all of a package's documentation must be located in a specified directory in the package's directory.
  • Source must compile under javadoc 1.2.
    The AutoRad system leverages the new "package documentation" file to accomodate dependencies and to build the package database. Further, the GJT leverages two custom doclets to generate the package documentation and source code javadoc documentation with links into the source code repository for online viewing. All of these features require javadoc 1.2.

AutoRad does not yet accomodate any concept of "make" or any "scripting" mechanism during the build phase. See the following Note regarding this decision.

Note that some of the current standards are the result of a purposely limited design. It was felt that it would be better to restrict the layout and processing of packages in anticipation of coming efforts and standards from other organizations, such as Sun or JavaSoft. It is expected that future releases of the GJT will accomodate more flexible and powerful standards.


All contents are copyrighted (c) by their respective authors. All rights reserved.
All contents are licensed under the General Public License.