Javadoc

1. Summary Fragment
2. Additional Paragraphs
3. Tags

Tags

Class:

• @author
• @version

Method:

• @param
• @return
• @throws

Class Comment

/**
 * Represents a square shape.
 *
 * <p>This class represents a square, 
 * storing the side length only.
 *
 * @author Russell Feldhausen russfeld@ksu.edu
 * @version 0.1
 */
public class Square {

Method Comment

/**
 * Calculates and returns the area of the square not in the circle.
 *
 * <p>This method will place the center of the circle at the center of
 * the square and compute the difference in area. 
 *
 * @param circle     a circle shape
 * @return           the difference in area
 * @throws IllegalArgumentException    if the circle is 
 *                                     larger than the square
 */
public double areaDifference(Circle circle){

Attribute Comment

/** The side length of the square. */
private int length;