Kari Hiitola, $Revision: 1.1.1.1 $
/* $Id: codeconv.html,v 1.1.1.1 2000/10/15 15:10:34 khiitola Exp $ */
package FI.hut.cs.osprey.somepart;
import com.example.package.*;
import com.example.package2.class;
/**
* Class Osprey needs a one-sentence description.
* Then a deeper analysis of its purpose and functionality,
* which may be much longer.
*
* @author Erkki Esimerkki
* @version $Revision: 1.1.1.1 $
*/
public class Osprey extends Something implements SomethingElse {
/**
* Public variables need a one-sentence description.
* Then a longer description if needed.
*/
public Type1 attribute;
/**
* Private attributes need a Javadoc comment only if
* they are of special importance.
*/
private Type2 somethingElse;
// Otherwise an non-formal comment is sufficient.
private Type3 completelyDifferent;
/**
* Constructor needs a one-sentence description.
* A deeper analysis may be necessary to fully describe
* functionality.
*
* @param paramA passes some information
* @param paramB is somehow important
*/
public Osprey(Type1 paramA, Type2 paramB) {
// Implementation here
}
/**
* SomeMethod needs a one-sentence description.
* A deeper analysis may be necessary to fully describe
* functionality.
*
* @param paramA passes some information
* @param paramB is somehow important
*
* @return what this method returns
*
* @throws reason and descr of the exception thrown by this method
*/
public ReturnType someMethod(Type1 paramA, Type2 paramB)
throws SomeException {
// Implementation here
}
}
/*
* $Id: codeconv.html,v 1.1.1.1 2000/10/15 15:10:34 khiitola Exp $
* REVISION HISTORY
* $Log: codeconv.html,v $
* Revision 1.1.1.1 2000/10/15 15:10:34 khiitola
*
*
*
*/