/**
*
* John E. Boon, Jr.
*
* Copyright (c) 2002 John E. Boon, Jr. (Work in Progress)
*
* Project: Example Java Template for javadoc
*
* Students are granted unlimited rights to this file.
*
*/
package PackageName;
import java.io.*;
/**
*
* The first sentence of each class description should be a summary statement.
* Class/interface documentation appears next. The key interface summary is
* placed where where is it readily available to persons scanning the
* documentation.
*
* Revision control information for this file follows:
*
*
* Program Description:
*
* - References:
*
* - Reference Information (e.g., M. T. Goodrich and R. Tamassia, Data
* Structures and Algorithms in Java ™.New York: John Wiley, and
* Sons, 1998. (Section 1.4, pages 14-15)
*
- Frakes, William B., Christopher J. Fox, and Brian A. Nejmeh,
* Software Engineering in the Unix® /C Environment, Englewood
* Cliffs, New Jersey: Prentice Hall, 1991.
*
* - Program Unit Notebook:
* Demo Program Unit Notebook.
* This is a separate file that contains information about this program that
* is not appropriate to store here (e.g. programmer metrics data, binary
* images).
*
- Program Goals: "A target action or state." "A program goal is a
* target action or state of a program or program segment. Programs or
* program segments are executed to achieve program goals. For example,
* a program segment goal might be to save data by spilling a buffer to
* a file whenever the buffer is full. Another might be present sorted
* data to the user upon request." [Frakes, Fox, and Nejmeh, page 55]
*
*
- Reusability Keywords : template javadoc
*
- Software Metrics (computed by RSM version 6.01)
*
* - Function: Class.Method
*
* - Cyclomatic Complexity V(g) = a
*
- LOC = b; eLOC = c; lLOC = d; Comment = e; Lines = f
*
*
*
*
*
* Runtime Environment:
*
* - Platform : Intel PentiumPro/Windows 2000 (Service Pack 2)
*
*
- Compiler Used : java version "1.4.0" Java(TM) 2 Runtime
* Environment, Standard Edition (build 1.4.0-b92)
* Java HotSpot(TM) Client VM (build 1.4.0-b92,
* mixed mode)/Forte for Java, Community
* Edition v. 3.0 (Build 010817)
*
- Compilation Switches : no special switches required
*
*
* Associated Files:
*
* - Input Files Needed : none
*
- Temporary Files Needed: none
*
- Output Files Needed : none
*
*
* Header Version : BOON-05-26-2002-GNU-CVS
*
* @author John E. Boon, Jr.
* @version $Revision$
* @see PackageName.otherClass
* @since 1.4.0
*/
public class demo extends Object {
/** Class (static) variables comments*/
/** Instance variables comments*/
/** Identifier comment */
public int i;
/** Key Data Structure:
* The first sentence should be a summary statement about this element.
*
* - Object Role: "A part played by a program object." "The role of
* a program is the part the object plays in a program. Details about
* an object's role usually depend on what sort of thing the object
* is. For example, the role of a variable is to store a particular
* data value, say a count of bytes in a buffer, or the sum of values
* encountered so far." [Frakes, Fox, and Nejmeh, page 55]
*
- Object Purpose: "The reason an object plays the role it does."
* "The purpose of a program object is a reason the Object plays the
* role that it does. An object's purposes are usually explained in
* the way it serves plans for achieving program goals. For example,
* the purpose of a byte counter might be to keep track of when a
* buffer should be spilled." [Frakes, Fox, and Nejmeh, page 56]
*
*/
protected int xx = 0;
/** Identifier comment
* Note: This is not parsed by javadoc becuase it is private.
* Documentation is provided for the module developer and maintainer.
*/
private static int jj = 0;
/** Constructors */
/**
* Method Name:
* The first sentence should be a summary statement about this Method.
*
* Method Signature: function: {source sets} -> {target sets}
*
* - domain function ::= {x member of ? | boolean expression on x}
*
- function(x) ::= some value in target set
*
*
* Method Plans: "An outline of steps for achieving a goal." "A plan
* is an outline of processing steps for achieving program goals.
* Plans are more abstract than algorithms, but they show how program
* goals are achieved. For instance, the following plan for adding
* data to a buffer achieves the goal of saving the data by spilling
* the buffer to a file when the buffer is full [Boon's note: this
* plan assumes that the buffer is sized as a multiple of the data
* item size that is to be added to the buffer]: 1. Add a single data
* item to the buffer; 2. If the buffer is full, spill it to the file.
* [Frakes, Fox, and Nejmeh, page 56]
*
* Precondition Axioms: (optional)
*
* Postcontdition Axioms: (Required)
*
* @param zz Must document each parameter.
* @return yy If the return type is not void you must document
* the return type.
* @throws aException for any checked or unchecked exceptions
* declared in throw clauses
*/
public demo() {
}
/** Methods */
/**
* finalize() if non-Java resources are used in this class.
*/
}