FreeHEP Java Library

Components and Tools for Java
Java Library FreeHEP
Member of FreeHEP Printable Page

Project Guidelines

Currently we have not developed any formal rules or policies. The following are some guidelines for authors.

  • Packages should include test/example code, normally in a package post fixed .test
  • Each class should include an @author tag, specifying the owner, and a @version tag specifying the version.
    (You can use @version $Id$ to get CVS to automatically generate version tags).
  • usage of external libraries, dependencies should be kept to minimum, and documented.
  • Each package should have a javadoc package.html file giving an overview of the functionality of the package.

Creating new packages

Before a new package is introduced it should be discussed on the FreeHEP developers mailing list. The discussion should help to clarify

  1. Whether the suggested functionality is useful, and likely to be of sufficient generality to be reused by others in future
  2. Whether the suggested functionality is already available elsewhere in the FreeHEP library or any other open source library
  3. Where in the FreeHEP hierarchy it belongs

As a result of these discussions it should be possible to provide a package.html file which describes the package and how it meets the above goals. In some cases it may be appropriate to initially insert the package in the preview area before it becomes clear if it meets all of the goals.