From: Egon W. <eg...@us...> - 2002-08-27 10:04:41
|
Update of /cvsroot/jmol/Jmol/src/org/openscience/jmol In directory usw-pr-cvs1:/tmp/cvs-serv2091/src/org/openscience/jmol Modified Files: ABINITReader.java AtomRenderer.java AtomTypeSet.java BaseAtomType.java ChargeColorProfile.java DefaultColorProfile.java Jmol.java RecentFilesDialog.java Log Message: Fixed a number of javadoc tags. Index: ABINITReader.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/ABINITReader.java,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -r1.1 -r1.2 *** ABINITReader.java 17 Aug 2002 11:58:29 -0000 1.1 --- ABINITReader.java 27 Aug 2002 10:04:34 -0000 1.2 *************** *** 54,57 **** --- 54,62 ---- public class ABINITReader implements ChemFileReader { + public static final double angstromPerBohr = 0.529177249; + + // This variable will be used to parse the input file + private StringTokenizer st; + /** * Create an ABINIT output reader. *************** *** 59,68 **** * @param input source of ABINIT data */ - - public static final double angstromPerBohr = 0.529177249; - - // This variable will be used to parse the input file - private StringTokenizer st; - public ABINITReader(Reader input) { this.input = new BufferedReader(input); --- 64,67 ---- Index: AtomRenderer.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/AtomRenderer.java,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -r1.5 -r1.6 *** AtomRenderer.java 10 Aug 2002 13:05:40 -0000 1.5 --- AtomRenderer.java 27 Aug 2002 10:04:34 -0000 1.6 *************** *** 179,183 **** * @param ballColor color for the sphere. * @param settings the display settings used for the light source. ! * @returns an image of a shaded sphere. */ private static Image sphereSetup(Color ballColor, --- 179,183 ---- * @param ballColor color for the sphere. * @param settings the display settings used for the light source. ! * @return an image of a shaded sphere. */ private static Image sphereSetup(Color ballColor, Index: AtomTypeSet.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/AtomTypeSet.java,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -r1.5 -r1.6 *** AtomTypeSet.java 2 Aug 2001 04:41:09 -0000 1.5 --- AtomTypeSet.java 27 Aug 2002 10:04:34 -0000 1.6 *************** *** 37,41 **** * * @param at AtomType to be added to the set. ! * @returns true if the set did not already contain the AtomType. */ boolean add(BaseAtomType at) { --- 37,41 ---- * * @param at AtomType to be added to the set. ! * @return true if the set did not already contain the AtomType. */ boolean add(BaseAtomType at) { Index: BaseAtomType.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/BaseAtomType.java,v retrieving revision 1.9 retrieving revision 1.10 diff -C2 -r1.9 -r1.10 *** BaseAtomType.java 24 May 2002 18:21:16 -0000 1.9 --- BaseAtomType.java 27 Aug 2002 10:04:34 -0000 1.10 *************** *** 47,51 **** * @param covalentRadius the covalent radius (helps determine bonding) * @param color the color for drawing ! * @returns the atom type corresponding to the name. */ public static BaseAtomType get(String name, String root, int atomicNumber, --- 47,51 ---- * @param covalentRadius the covalent radius (helps determine bonding) * @param color the color for drawing ! * @return the atom type corresponding to the name. */ public static BaseAtomType get(String name, String root, int atomicNumber, *************** *** 61,66 **** * * @param atomicNumber atomic number of the atom type to find. ! * @returns the first atom type with atomic number matching ! * parameter, or null if not found. */ public static BaseAtomType get(int atomicNumber) { --- 61,66 ---- * * @param atomicNumber atomic number of the atom type to find. ! * @return the first atom type with atomic number matching ! * parameter, or null if not found. */ public static BaseAtomType get(int atomicNumber) { *************** *** 83,87 **** * * @param name the name of this atom type (e.g. CA for alpha carbon) ! * @returns the atom type corresponding to the name. */ public static BaseAtomType get(String name) { --- 83,87 ---- * * @param name the name of this atom type (e.g. CA for alpha carbon) ! * @return the atom type corresponding to the name. */ public static BaseAtomType get(String name) { *************** *** 99,103 **** * * @param name the name of this atom type (e.g. CA for alpha carbon). ! * @returns true if the atom type exists. */ public static boolean exists(String name) { --- 99,103 ---- * * @param name the name of this atom type (e.g. CA for alpha carbon). ! * @return true if the atom type exists. */ public static boolean exists(String name) { Index: ChargeColorProfile.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/ChargeColorProfile.java,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -r1.1 -r1.2 *** ChargeColorProfile.java 10 Aug 2002 13:05:40 -0000 1.1 --- ChargeColorProfile.java 27 Aug 2002 10:04:34 -0000 1.2 *************** *** 29,33 **** /** * @param a Atom for which the color must be returned ! * @returns Color for charged atom */ public Color getColor(Atom a) { --- 29,33 ---- /** * @param a Atom for which the color must be returned ! * @return Color for charged atom */ public Color getColor(Atom a) { Index: DefaultColorProfile.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/DefaultColorProfile.java,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -r1.1 -r1.2 *** DefaultColorProfile.java 10 Aug 2002 13:05:40 -0000 1.1 --- DefaultColorProfile.java 27 Aug 2002 10:04:34 -0000 1.2 *************** *** 28,32 **** /** * @param a Atom for which the color must be returned ! * @returns Color for charged atom */ public Color getColor(Atom a) { --- 28,32 ---- /** * @param a Atom for which the color must be returned ! * @return Color for charged atom */ public Color getColor(Atom a) { Index: Jmol.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/Jmol.java,v retrieving revision 1.54 retrieving revision 1.55 diff -C2 -r1.54 -r1.55 *** Jmol.java 24 May 2002 18:21:17 -0000 1.54 --- Jmol.java 27 Aug 2002 10:04:34 -0000 1.55 *************** *** 721,725 **** * command. * @param cmd Name of the action. ! * @returns item created for the given command or null * if one wasn't created. */ --- 721,725 ---- * command. * @param cmd Name of the action. ! * @return item created for the given command or null * if one wasn't created. */ *************** *** 1377,1381 **** * if the property is not defined. * ! * @returns a File to the user directory */ static File getUserDirectory() { --- 1377,1381 ---- * if the property is not defined. * ! * @return a File to the user directory */ static File getUserDirectory() { Index: RecentFilesDialog.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/RecentFilesDialog.java,v retrieving revision 1.12 retrieving revision 1.13 diff -C2 -r1.12 -r1.13 *** RecentFilesDialog.java 24 May 2002 18:21:17 -0000 1.12 --- RecentFilesDialog.java 27 Aug 2002 10:04:34 -0000 1.13 *************** *** 136,140 **** /** ! * @returns String The name of the file picked or null if the action was aborted. **/ public String getFile() { --- 136,140 ---- /** ! * @return String The name of the file picked or null if the action was aborted. **/ public String getFile() { *************** *** 143,147 **** /** ! @returns String The type of the file picked or null if the action was aborted. **/ public String getFileType() { --- 143,147 ---- /** ! * @return String The type of the file picked or null if the action was aborted. **/ public String getFileType() { |