FR-1

Java centric

Jell is intended to be a java development tool.

FR-1.1

100% Java

The tool must be 100% java.

FR-1.2

JDKs

The tool must work using JDK 1.2 and later.

FR-1.3

Size

The tool must be small and easy to pass around.

FR-2

Reference Numbers

Jell must support alphanumeric reference numbers with a minimum of constraints.

FR-2.1

Multiple References

The tool must allow an element in the code to apply to multiple reference numbers.

FR-2.2

Number List

The tool must allow the user to define the allowed reference numbers.

FR-3

Implementation

Jell must be a Javadoc doclet.

FR-3.1

Tag

The tool must use a Javadoc tag element to identify reference numbers.

FR-3.2

User defined Tag

The tool must allow the user to identify the tag to use.

FR-3.3

Missing Tags

The tool must identify tags which are missing.

FR-3.4

Invalid Tag information

The tool must identify tags which are formatted incorrectly.

FR-3.5

Undefined Tags

The tool must report reference numbers that are present, but not defined in the Reference table.

FR-3.6

Unused Tags

The tool must report tags which are not referenced in the source code, but are defined in the reference table.

FR-3.7

Non-code related tags

The tool must allow the user to specify when a reference number does not relate to the code and therefore is defined, but not meant for reference.

FR-4

I18N

The tool must support internationalization eventually. This means that the delimiter in the tags must be flexible as well.

FR-5

Configurable

The tool must allow the user to configure preferences for operation.

FR-5.1

Reference Table Path

The tool must allow the user to set the name and path of the file containing containing the list of valid reference numbers.

FR-5.2

Output File

The tool must allow the user to specify the output file name and location.

FR-5.3

Default Output File

The tool must produce a default output file if non is specified.

FR-6

Output

The output must be a file.

FR-6.1

Output File Type

The output file must be XML.

FR-6.2

Output File DTD

The output file DTD must be defined.

FR-6.3

Output File Format

The output must be reference number centric. That is to say, the output must collect source elements related to each reference number as oppose to the collecting number related to an element of code.

FR-6.4

Output Reference Numbers

The output must present all of the reference numbers that should be present.

FR-6.5

Output Reference Number to Class

The output must identify all classes that refer to a number.

FR-6.6

Output Reference Number to Element

The output must identify all of the methods and variables which relate to the number.