From: Nico <ni...@us...> - 2004-11-07 17:18:23
|
Update of /cvsroot/jmol/Jmol/src/org/jmol/api In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv6961/src/org/jmol/api Modified Files: JmolAdapter.java Log Message: Removed some warnings (Eclipse) Index: JmolAdapter.java =================================================================== RCS file: /cvsroot/jmol/Jmol/src/org/jmol/api/JmolAdapter.java,v retrieving revision 1.10 retrieving revision 1.11 diff -u -r1.10 -r1.11 --- JmolAdapter.java 2 Nov 2004 11:28:47 -0000 1.10 +++ JmolAdapter.java 7 Nov 2004 17:18:11 -0000 1.11 @@ -93,7 +93,8 @@ public void finish(Object clientFile) {} /** - * returns the type of this file or molecular model, if known + * @param clientFile + * @return The type of this file or molecular model, if known */ public String getFileTypeName(Object clientFile) { return "unknown"; } @@ -101,6 +102,8 @@ * Some file formats contain a formal name of the molecule in the file. * If this method returns <code>null</code> then the JmolViewer will * automatically supply the file/URL name as a default. + * @param clientFile + * @return Formal name of the molecule */ public String getAtomSetCollectionName(Object clientFile) { return null; } @@ -108,6 +111,8 @@ * Get the properties for this atomSetCollection * * Not yet implemented everywhere, it is in the smarterJmolAdapter + * @param clientFile + * @return Properties */ public Properties getAtomSetCollectionProperties(Object clientFile) { return null; @@ -118,6 +123,8 @@ * * <p>This is currently only used for the script command 'show pdbheader' * Other than for pdb files, the client can return <code>null</code> + * @param clientFile + * @return File header */ public String getFileHeader(Object clientFile) { return null; } @@ -126,6 +133,8 @@ * * <p>NOTE WARNING: * <br>Not yet implemented everywhere, it is in the smarterJmolAdapter + * @param clientFile + * @return Number of atomSets */ public int getAtomSetCount(Object clientFile) { return 1; } @@ -136,6 +145,9 @@ * a 1-based atomSet number. *<p> * <i>Note that this is not currently implemented in PdbReader</i> + * @param clientFile + * @param atomSetIndex + * @return Number identifying the atomSet */ public int getAtomSetNumber(Object clientFile, int atomSetIndex) { return atomSetIndex + 1; @@ -143,6 +155,9 @@ /** * The name of each atomSet + * @param clientFile + * @param atomSetIndex + * @return Name of the atomSet */ public String getAtomSetName(Object clientFile, int atomSetIndex) { return "" + getAtomSetNumber(clientFile, atomSetIndex); @@ -150,6 +165,9 @@ /** * The properties for each atomSet + * @param clientFile + * @param atomSetIndex + * @return Properties of the atomSet */ public Properties getAtomSetProperties(Object clientFile, int atomSetIndex) { return null; @@ -158,10 +176,12 @@ /** * The estimated number of atoms contained in the file. * Just return -1 if you don't know (or don't want to figure it out) + * @param clientFile + * @return Estimated number of atoms */ abstract public int getEstimatedAtomCount(Object clientFile); - /** + /* * This method returns the parameters that define a crystal unitcell * the parameters are returned in a float[] in the following order * a, b, c, alpha, beta, gamma @@ -186,6 +206,8 @@ /** * Returns an AtomIterator used to retrieve all the atoms in the file. * This method may not return <code>null</code>. + * @param clientFile + * @return AtomIterator * @see AtomIterator */ abstract public AtomIterator getAtomIterator(Object clientFile); @@ -193,14 +215,17 @@ * Returns a BondIterator. If this method returns <code>null</code> and no * bonds are defined then the JmolViewer will automatically apply its * rebonding code to build bonds between atoms. + * @param clientFile + * @return BondIterator * @see BondIterator */ public BondIterator getBondIterator(Object clientFile) { return null; } /** * Returns a StructureIterator or <code>null</code> + * @param clientFile + * @return StructureIterator */ - public StructureIterator getStructureIterator(Object clientFile) { return null; } |