Example of HTML page generated by Java Document Generator

NOTE: None of the links in the body of this page go anywhere. Please return to the OVP column when you are done viewing this page

Class GenerateIntArray

java.lang.Object
  |
  +--GenerateIntArray
public class GenerateIntArray
extends Object

A simple class to generate random integer arrays, often quite useful for testing sorting algorithms.

Written as an example for an ACM Crossroads article about using javadoc, the Java API documentation generator of HTML pages.

See Also:
java.lang.Integer

Constructor Summary
GenerateIntArray()
           
 
Method Summary
 int[] generateRandomIntArray(int size, int min, int max)
          Create an array of primitive int values.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GenerateIntArray

public GenerateIntArray()
Method Detail

generateRandomIntArray

public int[] generateRandomIntArray(int size,
                                    int min,
                                    int max)
Create an array of primitive int values. Accept specified number of values to generate, and an inclusive range within which the generated values should fall.

This is a trivial method written just to demonstrate how a comment is written for Javadoc. Notice the special tags:

Parameters:
size - the size of the array to create (the number of values to generate)
min - the least value that may be generated
max - the greatest value that may be generated
Returns:
an array of size primitive int values between the min and max range, inclusive
Since:
0.1