[Cdk-commits] CVS: cdk/src/org/openscience/cdk/ringsearch/cyclebasis CycleBasis.java,1.3,1.4 SimpleCycle.java,1.2,1.3

[Egon W. <eg...@us...>]

Update of /cvsroot/cdk/cdk/src/org/openscience/cdk/ringsearch/cyclebasis
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7990/src/org/openscience/cdk/ringsearch/cyclebasis

Modified Files:
	CycleBasis.java SimpleCycle.java 
Log Message:
Fixed a few JavaDoc issues

Index: CycleBasis.java
===================================================================
RCS file: /cvsroot/cdk/cdk/src/org/openscience/cdk/ringsearch/cyclebasis/CycleBasis.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CycleBasis.java	1 Aug 2004 12:42:04 -0000	1.3
+++ CycleBasis.java	27 Sep 2004 09:45:59 -0000	1.4
@@ -249,7 +249,7 @@
 	/**
 	 * Returns the cycles that form the cycle basis.
 	 *
-	 * @returns a <Code>Collection</code> of the basis cycles
+	 * @return a <Code>Collection</code> of the basis cycles
 	 */
 
 	public Collection cycles() {
@@ -260,7 +260,7 @@
 	 * Returns the essential cycles of this cycle basis.
 	 * A essential cycle is contained in every minimum cycle basis of a graph.
 	 *
-	 * @returns a <Code>Collection</code> of the essential cycles
+	 * @return a <Code>Collection</code> of the essential cycles
 	 */
 
 	public Collection essentialCycles() {
@@ -279,7 +279,7 @@
 	 * Returns the essential cycles of this cycle basis.
 	 * A relevant cycle is contained in some minimum cycle basis of a graph.
 	 *
-	 * @returns a <Code>Map</code> mapping each relevant cycles to the corresponding
+	 * @return a <Code>Map</code> mapping each relevant cycles to the corresponding
 	 * basis cycle in this basis
 	 */
 
@@ -300,7 +300,7 @@
 	 * Two cycles belong to the same commected component if there is a circuit (a minimal 
 	 * dependent set) containing both cycles.
 	 *
-	 * @returns a <Code>List</code> of <Code>Set</code>s consisting of the cycles in a
+	 * @return a <Code>List</code> of <Code>Set</code>s consisting of the cycles in a
 	 * equivalence class.
 	 */
 

Index: SimpleCycle.java
===================================================================
RCS file: /cvsroot/cdk/cdk/src/org/openscience/cdk/ringsearch/cyclebasis/SimpleCycle.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SimpleCycle.java	20 Sep 2004 17:32:56 -0000	1.2
+++ SimpleCycle.java	27 Sep 2004 09:45:59 -0000	1.3
@@ -55,7 +55,6 @@
  * @cdk.builddepends jgrapht-0.5.3.jar
  * @cdk.depends jgrapht-0.5.3.jar
  */
-
 public class SimpleCycle extends UndirectedSubgraph {
 
 	/**
@@ -91,7 +90,7 @@
 	/**
 	 * Returns the sum of the weights of all edges in this cycle.
 	 *
-	 * @returns the sum of the weights of all edges in this cycle
+	 * @return the sum of the weights of all edges in this cycle
 	 */
 	public double weight() {
 		double result = 0;
@@ -106,7 +105,7 @@
 	 * Returns a list of the vertices contained in this cycle.
 	 * The vertices are in the order of a traversal of the cycle.
 	 *
-	 * @returns a list of the vertices contained in this cycle
+	 * @return a list of the vertices contained in this cycle
 	 */
 	public List vertexList() {
 		List vertices = new ArrayList(edgeSet().size());