/** This class is a demo of javadoc.<br>
 *  This comment will go at the top with the name of the class.
 * <br> To javadoc this file while creating a tech spec, try
 * <br><code>javadoc -private UsingJavadoc.java</code>
 */
public class UsingJavadoc {

    /** the integer x.<br> this top part will go in the field summary. 
     * This part on the next line goes into the field details */
    private int x; 
    /** the integer y */
    public int y; 

    /** the default constructor.
     * <br>The top line of this comment will go in the constructor summary
     * <br>All the lines go into the constructor detail. 
     */
    public UsingJavadoc() { }

    /**
     * purpose: this is an example of what Javadoc can do
     * <br>These lines go into the method summary. As soon as i use a period 
     * (see the beginning of this sentence), it stops.
     *
     * All lines go into the method detail. Note that despite the blank
     * line above this section, we dont get a line break. you can use an 
     * html tag to make line breaks. (Notice the line <br> break in the 
     * Javadoc)
     *
     * @param p this is my parameter...
     * @return this method returns an integer which is the input plus one
     *
     * <br><br><code> code or pseudo code goes in tags like these </code>
     * Notice that the previous words appear in a different font.
     *
     * <p>other html tags such as <p> for paragraph work too. Notice that 
     * a new paragraph started in the Javadoc. If you know other html tags, 
     * you can experiment with them.
     *
     * <p>Don't use too many html tags tho since it makes the Java harder 
     * to read
     * 
     * <p>precondition: not a whole lot
     *
     * <p>postcondition: something i'm sure
     * 
     * <P>There are html tags which render lines as-is. These may also 
     * help with pseudo code.
     * <pre>
     * this is being               shown   exactly    as typed
     *    even the line breaks       and crazy spacing
notice that if i leave the star off the begining of the line,  
       the start is from the page edge, not the star line
     * </pre>
     */
    public int someMethod(int p) {
	return p + 1;
    }

    /**
     * Other commands you can give javadoc.
     *
     * <br> <code>javadoc -d a_directory</code>
     * <br>The resulting html files will be put in the "a_directory" directory.
     *
     * <br><br> <code>javadoc -help</code>
     * <br>This will let you see all the options javadoc can use
     */
    public void moreOnJavadoc() { 

    }
}