From: Egon W. <eg...@us...> - 2003-06-14 20:05:10
|
Update of /cvsroot/jmol/Jmol/src/org/openscience/jmol In directory sc8-pr-cvs1:/tmp/cvs-serv20834/src/org/openscience/jmol Modified Files: Tag: b6 Convertor.java CrystalFile.java EnergyBand.java Log Message: Fixed JavaDoc in order to reduce complaints during building dists Index: Convertor.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/Convertor.java,v retrieving revision 1.2.2.4 retrieving revision 1.2.2.5 diff -u -r1.2.2.4 -r1.2.2.5 --- Convertor.java 15 May 2003 19:00:21 -0000 1.2.2.4 +++ Convertor.java 14 Jun 2003 20:05:08 -0000 1.2.2.5 @@ -34,16 +34,13 @@ /** * Class that provides convertor procedures to - * convert CDK classes to Jmol (v5) classes and visa versa. + * convert CDK classes to Jmol (v7) classes and visa versa. * - * Jmol is a Java 3D viewer specialized for viewing + * <p>Jmol is a Java 3D viewer specialized for viewing * animations and vibrational modes. It * can be found at: http://jmol.sourceforge.net/ * * @author egonw - * - * @keyword Jmol - * @keyword class convertor */ public class Convertor { Index: CrystalFile.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/CrystalFile.java,v retrieving revision 1.16.2.3 retrieving revision 1.16.2.4 diff -u -r1.16.2.3 -r1.16.2.4 --- CrystalFile.java 14 Jun 2003 19:06:50 -0000 1.16.2.3 +++ CrystalFile.java 14 Jun 2003 20:05:08 -0000 1.16.2.4 @@ -36,44 +36,53 @@ /** * The class <code>CrystalFile</code> defines the properties of a crystal and * has a method to generate a set of atoms representing a part - * of the crystal.<br> + * of the crystal. * - * How to use this class? It works as a state machine. + * <p>How to use this class? It works as a state machine. * Create a <code>CrystalFile</code> object and - * set the crystal properties to the desired values:<br><br> + * set the crystal properties to the desired values: + * <pre> + * CrystalFile cf = new CrystalFile(); + * cf.setUnitCellBox(new UnitCellBox(...)); + * (use the constructor appropriated to your needs) + * (so far, only the trivial space group "1" is implemented) + * cf.setCrystalBox(new CrystalBox(...)); + * </pre> * - * <code>CrystalFile cf = new CrystalFile();</code><br> - * <code>cf.setUnitCellBox(new UnitCellBox(...));</code><br> - * (use the constructor appropriated to your needs)<br> - * (so far, only the trivial space group "1" is implemented)<br> - * <code>cf.setCrystalBox(new CrystalBox(...));</code><br> - - * You have now settled all the necessary information and you can - * generate the crystal:<br><br> - * <code>cf.generateCrystalFrame();</code><br><br> - * - * If you have more frames, you can set the properties to any other desired - * value and generate a new frame.<br> - * <code>cf.setUnitCellBox(...);</code><br> - * <code>cf.generateCrystalFrame();</code><br> - * and so on if you want to add more frames.<br><br> + * <p>You have now settled all the necessary information and you can + * generate the crystal: + * <pre> + * cf.generateCrystalFrame(); + * </pre> * - * The generated frames are stored in a field of the <code>super</code> + * <p>If you have more frames, you can set the properties to any other desired + * value and generate a new frame. + * <pre> + * cf.setUnitCellBox(...); + * cf.generateCrystalFrame(); + * and so on if you want to add more frames. + * </pre> + * + * <p>The generated frames are stored in a field of the <code>super</code> * class (<code>ChemFile</code>) and can be accessed with: - * <code>cf.getFrame(whichframe);</code><br><br> + * <pre> + * cf.getFrame(whichframe); + * </pre> * - * The crystal properties of a frame can be read with:<br> - * <code>cf.getUnitCellBox(whichframe)</code>, - * <code>cf.getCrystalBox(whichframe)</code><br> - * - * The crystal properties state (used to generate a new frame) - * can be read with:<br> - * <code>cf.getUnitCellBox()</code>, - * <code>cf.getCrystalBox()</code><br> + * <p>The crystal properties of a frame can be read with: + * <pre> + * cf.getUnitCellBox(whichframe) + * cf.getCrystalBox(whichframe) + * </pre> * + * <p>The crystal properties state (used to generate a new frame) + * can be read with: + * <pre> + * cf.getUnitCellBox() + * cf.getCrystalBox() + * </pre> * * @author Fabian Dortu (Fab...@wa...) - * @version 1.2 */ public class CrystalFile extends ChemFile { @@ -142,11 +151,13 @@ /** - * Default constructor:<br> - * Create a CrystalFile object using default parameters.<br> - * By default, the primitive vectors + * Create a CrystalFile object using default parameters. + * + * <p>By default, the primitive vectors * set to define a cube, the space group is set to 1 * and the atom box and bond box are set to {0,0,0}->{1,1,1}. + * + * <p>This is the default constructor. */ public CrystalFile(DisplayControl control) { super(control); @@ -285,8 +296,8 @@ /** - * Generate a frame given by its index.<br> - * The frame must exist or be the last frame index + 1. + * Generate a frame given by its index. + * <p>The frame must exist or be the last frame index + 1. * * @param whichframe an <code>int</code> value. */ Index: EnergyBand.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/openscience/jmol/EnergyBand.java,v retrieving revision 1.3.2.1 retrieving revision 1.3.2.2 diff -u -r1.3.2.1 -r1.3.2.2 --- EnergyBand.java 5 May 2003 13:39:07 -0000 1.3.2.1 +++ EnergyBand.java 14 Jun 2003 20:05:08 -0000 1.3.2.2 @@ -27,9 +27,9 @@ import javax.vecmath.Point3d; /** - * A class to store the "Energy Band" property for a frame <br><br> + * A class to store the "Energy Band" property for a frame. * - * Usage: <br><br> + * <p>Usage: <br><br> * * 1) Create a new EnergyBand object:<br> * <code>EnergyBand energyBand = new EnergyBand(orig, origName, end, endName, nkpt, nband);</code> <br><br> |