Inherit JavaDoc where methods overwrite a super method

cdk · Jun 23, 2010 · d4a9436 · d4a9436
1 parent 02020d6
commit d4a9436
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 41 deletions.
diff --git a/src/main/org/openscience/cdk/signature/AtomSignature.java b/src/main/org/openscience/cdk/signature/AtomSignature.java
@@ -82,10 +82,7 @@ public int getIntLabel(int vertexIndex) {
         return atom.getMassNumber();
     }
 
-    /* (non-Javadoc)
-     * @see signature.AbstractVertexSignature#getConnected(int)
-     */
-    @Override
+    @Override /** {@inheritDoc} */
     public int[] getConnected(int vertexIndex) {
         IAtom atom  = this.molecule.getAtom(vertexIndex);
         List<IAtom> connected = this.molecule.getConnectedAtomsList(atom);
@@ -97,10 +94,7 @@ public int[] getConnected(int vertexIndex) {
         return connectedIndices;
     }
 
-    /* (non-Javadoc)
-     * @see signature.AbstractVertexSignature#getEdgeLabel(int, int)
-     */
-    @Override
+    @Override /** {@inheritDoc} */
     public String getEdgeLabel(int vertexIndex, int otherVertexIndex) {
         IAtom atomA = this.molecule.getAtom(vertexIndex);
         IAtom atomB = this.molecule.getAtom(otherVertexIndex);
@@ -119,10 +113,7 @@ public String getEdgeLabel(int vertexIndex, int otherVertexIndex) {
         }
     }
 
-    /* (non-Javadoc)
-     * @see signature.AbstractVertexSignature#getVertexSymbol(int)
-     */
-    @Override
+    @Override /** {@inheritDoc} */
     public String getVertexSymbol(int vertexIndex) {
         return this.molecule.getAtom(vertexIndex).getSymbol();
     }

diff --git a/src/main/org/openscience/cdk/signature/MoleculeFromSignatureBuilder.java b/src/main/org/openscience/cdk/signature/MoleculeFromSignatureBuilder.java
@@ -59,10 +59,7 @@ public MoleculeFromSignatureBuilder(IChemObjectBuilder builder) {
         this.builder = builder;
     }
 
-    /* (non-Javadoc)
-     * @see signature.AbstractGraphBuilder#makeEdge(int, int, java.lang.String, java.lang.String, java.lang.String)
-     */
-    @Override
+    @Override /** {@inheritDoc} */
     public void makeEdge(int vertexIndex1, int vertexIndex2,
             String vertexSymbol1, String vertexSymbol2, String edgeLabel) {
         if (edgeLabel.equals("")) {
@@ -74,18 +71,12 @@ public void makeEdge(int vertexIndex1, int vertexIndex2,
         }
     }
 
-    /* (non-Javadoc)
-     * @see signature.AbstractGraphBuilder#makeGraph()
-     */
-    @Override
+    @Override /** {@inheritDoc} */
     public void makeGraph() {
         this.container = this.builder.newInstance(IAtomContainer.class);
     }
 
-    /* (non-Javadoc)
-     * @see signature.AbstractGraphBuilder#makeVertex(java.lang.String)
-     */
-    @Override
+    @Override /** {@inheritDoc} */
     public void makeVertex(String label) {
         this.container.addAtom(this.builder.newInstance(IAtom.class, label));
     }

diff --git a/src/main/org/openscience/cdk/signature/MoleculeSignature.java b/src/main/org/openscience/cdk/signature/MoleculeSignature.java
@@ -69,12 +69,12 @@ public MoleculeSignature(IMolecule molecule, int height) {
         this.molecule = molecule;
     }
 
-    @Override
+    @Override /** {@inheritDoc} */
     public int getVertexCount() {
         return this.molecule.getAtomCount();
     }
 
-    @Override
+    @Override /** {@inheritDoc} */
     public String signatureStringForVertex(int vertexIndex) {
         AtomSignature atomSignature;
         int height = super.getHeight();
@@ -87,14 +87,14 @@ public String signatureStringForVertex(int vertexIndex) {
         return atomSignature.toCanonicalString();
     }
 
-    @Override
+    @Override /** {@inheritDoc} */
     public String signatureStringForVertex(int vertexIndex, int height) {
         AtomSignature atomSignature = 
             new AtomSignature(vertexIndex, height, this.molecule);
         return atomSignature.toCanonicalString();
     }
 
-    @Override
+    @Override /** {@inheritDoc} */
     public AbstractVertexSignature signatureForVertex(int vertexIndex) {
         return new AtomSignature(vertexIndex, this.molecule);
     }

diff --git a/src/main/org/openscience/cdk/signature/Orbit.java b/src/main/org/openscience/cdk/signature/Orbit.java
@@ -67,16 +67,12 @@ public Orbit(String label, int height) {
         this.height = height;
     }
 
-    /* (non-Javadoc)
-     * @see java.lang.Iterable#iterator()
-     */
+    /** {@inheritDoc} */
     public Iterator<Integer> iterator() {
         return this.atomIndices.iterator();
     }
 
-    /* (non-Javadoc)
-     * @see java.lang.Object#clone()
-     */
+    /** {@inheritDoc} */
     @TestMethod("testClone")
     public Object clone() {
         Orbit orbit = new Orbit(this.label, this.height);
@@ -180,9 +176,7 @@ public boolean contains(int atomIndex) {
         return this.atomIndices.contains(atomIndex);
     }
 
-    /* (non-Javadoc)
-     * @see java.lang.Object#toString()
-     */
+    /** {@inheritDoc} */
     public String toString() {
         return label + " " +
         Arrays.deepToString(atomIndices.toArray()); 

diff --git a/src/main/org/openscience/cdk/signature/SignatureQuotientGraph.java b/src/main/org/openscience/cdk/signature/SignatureQuotientGraph.java
@@ -73,10 +73,7 @@ public SignatureQuotientGraph(IAtomContainer atomContainer, int height) {
         super.construct(moleculeSignature.getSymmetryClasses(height));
     }
 
-    /* (non-Javadoc)
-     * @see signature.AbstractQuotientGraph#isConnected(int, int)
-     */
-    @Override
+    @Override /** {@inheritDoc} */
     public boolean isConnected(int index1, int index2) {
         IAtom atom1 = atomContainer.getAtom(index1);
         IAtom atom2 = atomContainer.getAtom(index2);