From bcaabdda9b0c07aa4570e3a84b1305593aa3522a Mon Sep 17 00:00:00 2001 From: egonw Date: Tue, 4 Jan 2005 15:01:02 +0000 Subject: [PATCH] Added @cdk.bug tag and used this for some classes with long standing bugs git-svn-id: https://cdk.svn.sourceforge.net/svnroot/cdk/trunk/cdk@3559 eb4e18e3-b210-0410-a6ab-dec725e4b171 --- doc/javadoc/source/CDKBugTaglet.java | 93 +++++++++++++++++++ javadoc.xml | 2 + src/org/openscience/cdk/Reaction.java | 8 +- src/org/openscience/cdk/io/CMLWriter.java | 1 + .../openscience/cdk/libio/cml/Convertor.java | 1 + .../openscience/cdk/renderer/Renderer2D.java | 1 + .../cdk/smiles/SmilesGenerator.java | 1 + .../openscience/cdk/smiles/SmilesParser.java | 1 + 8 files changed, 104 insertions(+), 4 deletions(-) create mode 100644 doc/javadoc/source/CDKBugTaglet.java diff --git a/doc/javadoc/source/CDKBugTaglet.java b/doc/javadoc/source/CDKBugTaglet.java new file mode 100644 index 00000000000..277b3d5045e --- /dev/null +++ b/doc/javadoc/source/CDKBugTaglet.java @@ -0,0 +1,93 @@ +/* $RCSfile$ + * $Author$ + * $Date$ + * $Revision$ + * + * Copyright (C) 2004 The Chemistry Development Kit (CDK) project + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public License + * as published by the Free Software Foundation; either version 2.1 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + */ +import com.sun.tools.doclets.Taglet; +import com.sun.javadoc.*; +import java.util.Map; + +/** + * Taglet that expands @cdk.bug tag into a weblink to CDK's + * SourceForge bug track system. It's typically used as: + * 
+ *   @cdk.bug 1095690
+ *
+ */ +public class CDKBugTaglet implements Taglet { + + private static final String NAME = "cdk.bug"; + + public String getName() { + return NAME; + } + + public boolean inField() { + return false; + } + + public boolean inConstructor() { + return false; + } + + public boolean inMethod() { + return false; + } + + public boolean inOverview() { + return false; + } + + public boolean inPackage() { + return false; + } + + public boolean inType() { + return true; + } + + public boolean isInlineTag() { + return false; + } + + public static void register(Map tagletMap) { + CDKBugTaglet tag = new CDKBugTaglet(); + Taglet t = (Taglet) tagletMap.get(tag.getName()); + if (t != null) { + tagletMap.remove(tag.getName()); + } + tagletMap.put(tag.getName(), tag); + } + + public String toString(Tag tag) { + return "
This class is affected by these bug(s):
" + + "" + tag.text() + "
\n"; + } + + public String toString(Tag[] tags) { + if (tags.length == 0) { + return null; + } else { + return toString(tags[0]); + } + } + +} diff --git a/javadoc.xml b/javadoc.xml index ee688c876dd..bb068e35539 100755 --- a/javadoc.xml +++ b/javadoc.xml @@ -35,6 +35,7 @@ public="true" windowtitle="CDK API - version ${version}"> + @@ -42,6 +43,7 @@ + diff --git a/src/org/openscience/cdk/Reaction.java b/src/org/openscience/cdk/Reaction.java index be3869ffe45..c1d8bc16b28 100644 --- a/src/org/openscience/cdk/Reaction.java +++ b/src/org/openscience/cdk/Reaction.java @@ -28,7 +28,6 @@ */ package org.openscience.cdk; - /** * Represents the idea of a chemical reaction. The reaction consists of * a set of reactants and a set of products. @@ -39,9 +38,10 @@ * * @cdk.module core * - * @author Egon Willighagen - * @cdk.created 2003-02-13 - * @cdk.keyword reaction + * @author Egon Willighagen + * @cdk.created 2003-02-13 + * @cdk.keyword reaction + * @cdk.bug 1095690 */ public class Reaction extends ChemObject implements java.io.Serializable, Cloneable { diff --git a/src/org/openscience/cdk/io/CMLWriter.java b/src/org/openscience/cdk/io/CMLWriter.java index 767b1af3050..12ace903a43 100644 --- a/src/org/openscience/cdk/io/CMLWriter.java +++ b/src/org/openscience/cdk/io/CMLWriter.java @@ -114,6 +114,7 @@ * @cdk.depends pmrlib.jar * @cdk.depends cmlAll.jar * @cdk.require java1.4 + * @cdk.bug 905062 * * @see java.io.FileWriter * @see java.io.StringWriter diff --git a/src/org/openscience/cdk/libio/cml/Convertor.java b/src/org/openscience/cdk/libio/cml/Convertor.java index 993a8aa2697..a1dc006d859 100644 --- a/src/org/openscience/cdk/libio/cml/Convertor.java +++ b/src/org/openscience/cdk/libio/cml/Convertor.java @@ -74,6 +74,7 @@ * @cdk.module extra * @cdk.keyword CML * @cdk.keyword class convertor + * @cdk.bug 905062 * * @cdk.builddepends base.jar * @cdk.builddepends pmrlib.jar diff --git a/src/org/openscience/cdk/renderer/Renderer2D.java b/src/org/openscience/cdk/renderer/Renderer2D.java index 4073838dc70..4022b642add 100644 --- a/src/org/openscience/cdk/renderer/Renderer2D.java +++ b/src/org/openscience/cdk/renderer/Renderer2D.java @@ -93,6 +93,7 @@ * * @cdk.created 2002-10-03 * @cdk.keyword viewer, 2D-viewer + * @cdk.bug 834515 * * @see org.openscience.cdk.renderer.Renderer2DModel */ diff --git a/src/org/openscience/cdk/smiles/SmilesGenerator.java b/src/org/openscience/cdk/smiles/SmilesGenerator.java index 8b10a2fd85c..c24e8ee6ef9 100644 --- a/src/org/openscience/cdk/smiles/SmilesGenerator.java +++ b/src/org/openscience/cdk/smiles/SmilesGenerator.java @@ -66,6 +66,7 @@ * @author Stefan Kuhn (chiral smiles) * @cdk.created 2002-02-26 * @cdk.keyword SMILES, generator + * @cdk.bug 1089770 */ public class SmilesGenerator { private static boolean debug = false; diff --git a/src/org/openscience/cdk/smiles/SmilesParser.java b/src/org/openscience/cdk/smiles/SmilesParser.java index a96630167f9..fb56a4b987a 100644 --- a/src/org/openscience/cdk/smiles/SmilesParser.java +++ b/src/org/openscience/cdk/smiles/SmilesParser.java @@ -67,6 +67,7 @@ * @author Egon Willighagen * @cdk.created 2002-04-29 * @cdk.keyword SMILES, parser + * @cdk.bug 1095696 */ public class SmilesParser {