edu.pdx.cs410J.lang.Javadoc Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of examples Show documentation

The newest version!

package edu.pdx.cs410J.lang;

/**
 * This class demonstrates Javadoc comments
 *
 * @author David Whitlock
 * @version 1.0
 */
public class Javadoc {

  /**
   * Returns the inverse of a double
   * @param d
   *        The double to invert
   * @return The inverse of a double
   * @throws IllegalArgumentException
   *         The double is zero
   */
  public double invert(double d) 
    throws IllegalArgumentException {
    if (d == 0.0) {
      String s = d + " can't be zero!";
      throw new IllegalArgumentException(s);
    } else {
      return 1.0 / d;
    }
  }
}