You guys really had something against updating the javadoc comments when
you did the refactoring, didn't you? :-P
The following reduces the number of javadoc errors/warnings while building
xdoclet by about 80%. They're mainly due to the methods being moved into
other classes when the stuff got moved into the tag handles, so it doesn't
find them any more. There were a couple of others that were using
ordinary comments instead of javadoc comments (i.e. /* instead of /**)
The ones still remaining are, I believe, because they're links to/from
private variables and methods, which javadoc doesn't include unless you
specify the -private option.
Andrew.
cvs server: Diffing core/src/xdoclet
Index: core/src/xdoclet/SubTask.java
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/src/xdoclet/SubTask.java,v
retrieving revision 1.56
diff -r1.56 SubTask.java
16,18c16,18
< * SubTask derives from xdoclet.util.TemplateEngine, where the template
engine
< * is implemented. Through inheritance it uses some of methods of
< * TemplateEngine to control the template logic.</p> <p>
---
> * SubTask derives from {@link xdoclet.template.TemplateEngine}, where
the
> * template engine is implemented. Through inheritance it uses some of
methods
> * of TemplateEngine to control the template logic.</p> <p>
Index: core/src/xdoclet/TemplateSubTask.java
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/src/xdoclet/TemplateSubTask.java,v
retrieving revision 1.3
diff -r1.3 TemplateSubTask.java
51,54c51,54
< * @see setOfType()
< * @see getOfType()
< * @see setExtent()
< * @see getExtent()
---
> * @see #setOfType(java.lang.String)
> * @see #getOfType()
> * @see #setExtent(TemplateSubTask.ExtentTypes)
> * @see #getExtent()
58,61c58,61
< /*
< * You can control the extent in which the type search occures.
Valid values
< * are: <i>concrete-type</i>, <i>superclass</i> and
<i>hierarchy</i> which is
< * the default.
---
> /**
> * You can control the extent in which the type search occures.
Valid values
> * are: <i>concrete-type</i> , <i>superclass</i> and
<i>hierarchy</i> which is
> * the default.
63,66c63,66
< * @see setExtent()
< * @see getExtent()
< * @see setOfType()
< * @see getOfType()
---
> * @see #setExtent(TemplateSubTask.ExtentTypes)
> * @see #getExtent()
> * @see #setOfType(java.lang.String)
> * @see #getOfType()
70,72c70,72
< /*
< * A class should have the class tag defined in this property in
order to be
< * processed and output generated for.
---
> /**
> * A class should have the class tag defined in this property in
order to be
> * processed and output generated for.
74,75c74,75
< * @see setHavingClassTag()
< * @see getHavingClassTag()
---
> * @see #setHavingClassTag(java.lang.String)
> * @see #getHavingClassTag()
cvs server: Diffing core/src/xdoclet/doc
cvs server: Diffing core/src/xdoclet/doc/info
cvs server: Diffing core/src/xdoclet/ejb
Index: core/src/xdoclet/ejb/SessionSubTask.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/SessionSubTask.java,v
retrieving revision 1.9
diff -r1.9 SessionSubTask.java
25c25
< * @see #getEntityBmpClassPattern()
---
> * @see #getSessionClassPattern()
56c56
< * @see #entityBmpClassPattern
---
> * @see #sessionClassPattern
cvs server: Diffing core/src/xdoclet/ejb/tags
Index: core/src/xdoclet/ejb/tags/BmpTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/tags/BmpTagsHandler.java,v
retrieving revision 1.2
diff -r1.2 BmpTagsHandler.java
53c53
< * @see
#isEntityBmp(com.sun.javadoc.ClassDoc)
---
> * @see
#isEntityBmp(com.sun.javadoc.ClassDoc,xdoclet.DocletContext)
81c81
< * @see
#useSoftLocking(com.sun.javadoc.ClassDoc)
---
> * @see
#useSoftLocking(com.sun.javadoc.ClassDoc,xdoclet.DocletContext)
Index: core/src/xdoclet/ejb/tags/CmpTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/tags/CmpTagsHandler.java,v
retrieving revision 1.2
diff -r1.2 CmpTagsHandler.java
91c91
< * @see
#isEntityCmp(com.sun.javadoc.ClassDoc)
---
> * @see
#isEntityCmp(com.sun.javadoc.ClassDoc,xdoclet.DocletContext)
121,123c121,123
< * @see
#isEntityCmp(com.sun.javadoc.ClassDoc)
< * @see
#isPersistentField(com.sun.javadoc.MethodDoc)
< * @see #isGetter(java.lang.String)
---
> * @see
#isEntityCmp(com.sun.javadoc.ClassDoc,xdoclet.DocletContext)
> * @see
PersistentTagsHandler#isPersistentField(com.sun.javadoc.MethodDoc)
> * @see
MethodTagsHandler#isGetter(java.lang.String)
Index: core/src/xdoclet/ejb/tags/EjbTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/tags/EjbTagsHandler.java,v
retrieving revision 1.3
diff -r1.3 EjbTagsHandler.java
33,34c33,34
< * @see #ejbspec
< * @see #setEjbspec(java.lang.String)
---
> * @see xdoclet.ejb.EjbDocletTask#ejbspec
> * @see
xdoclet.ejb.EjbDocletTask#setEjbspec(EjbDocletTask.EjbSpecVersion)
47c47
< * @see
#getEjbName(com.sun.javadoc.ClassDoc)
---
> * @see
#getEjbNameFor(com.sun.javadoc.ClassDoc,xdoclet.DocletContext)
74a75
> * @see
#getShortEjbNameFor(com.sun.javadoc.ClassDoc,xdoclet.DocletContext)
88,90c89,91
< * @see
#isEntity(com.sun.javadoc.ClassDoc)
< * @see
#isSession(com.sun.javadoc.ClassDoc)
< * @see
#isMessageDriven(com.sun.javadoc.ClassDoc)
---
> * @see
EntityTagsHandler#isEntity(com.sun.javadoc.ClassDoc)
> * @see
SessionTagsHandler#isSession(com.sun.javadoc.ClassDoc)
> * @see
MdbTagsHandler#isMessageDriven(com.sun.javadoc.ClassDoc)
145,147c146,148
< * @see
#isEntity(com.sun.javadoc.ClassDoc)
< * @see
#isSession(com.sun.javadoc.ClassDoc)
< * @see
#isMessageDriven(com.sun.javadoc.ClassDoc)
---
> * @see
EntityTagsHandler#isEntity(com.sun.javadoc.ClassDoc)
> * @see
SessionTagsHandler#isSession(com.sun.javadoc.ClassDoc)
> * @see
MdbTagsHandler#isMessageDriven(com.sun.javadoc.ClassDoc)
177,180c178,181
< * @see #sessionClass()
< * @see #entityBmpClass()
< * @see #entityCmpClass()
< * @see #messageDrivenClass()
---
> * @see SessionTagsHandler#sessionClass()
> * @see BmpTagsHandler#entityBmpClass()
> * @see CmpTagsHandler#entityCmpClass()
> * @see
MdbTagsHandler#messageDrivenClass()
257a259
> * @see #ejbName()
277a280,288
> /**
> * Returns short version of the EJB name of the clazz.
> *
> * @param clazz the class we want its short EJB
name
> * @param context Description of Parameter
> * @return The shortEjbName value
> * @exception XDocletException Description of Exception
> * @see #shortEjbName()
> */
Index: core/src/xdoclet/ejb/tags/EntityTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/tags/EntityTagsHandler.java,
v
retrieving revision 1.3
diff -r1.3 EntityTagsHandler.java
40,41c40,41
< * @see
#isEntityCmp(com.sun.javadoc.ClassDoc)
< * @see
#isEntityBmp(com.sun.javadoc.ClassDoc)
---
> * @see
CmpTagsHandler#isEntityCmp(com.sun.javadoc.ClassDoc,xdoclet.DocletContext)
> * @see
BmpTagsHandler#isEntityBmp(com.sun.javadoc.ClassDoc,xdoclet.DocletContext)
Index: core/src/xdoclet/ejb/tags/HomeTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/tags/HomeTagsHandler.java,v
retrieving revision 1.3
diff -r1.3 HomeTagsHandler.java
111,112c111,112
< * Similar to {@link #getComponentInterface}. Relies on the
ejb:home tag,
< * which has the following relevant properties:
---
> * Similar to {@link InterfaceTagsHandler#getComponentInterface}.
Relies on
> * the ejb:home tag, which has the following relevant properties:
Index: core/src/xdoclet/ejb/tags/PersistentTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/tags/PersistentTagsHandler.j
ava,v
retrieving revision 1.2
diff -r1.2 PersistentTagsHandler.java
142c142
< * @see
#fieldList(java.lang.String,java.lang.String,boolean)
---
> * @see
#fieldList(com.sun.javadoc.ClassDoc,java.lang.String,java.lang.String,bool
ean)
158c158
< * @see
#fieldList(java.lang.String,java.lang.String,boolean)
---
> * @see
#fieldList(com.sun.javadoc.ClassDoc,java.lang.String,java.lang.String,bool
ean)
Index: core/src/xdoclet/ejb/tags/PkTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/tags/PkTagsHandler.java,v
retrieving revision 1.3
diff -r1.3 PkTagsHandler.java
59c59
< * @see
#fieldList(java.lang.String,java.lang.String,boolean)
---
> * @see
PersistentTagsHandler#fieldList(com.sun.javadoc.ClassDoc,java.lang.String,
java.lang.String,boolean)
Index: core/src/xdoclet/ejb/tags/RelationTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/tags/RelationTagsHandler.jav
a,v
retrieving revision 1.2
diff -r1.2 RelationTagsHandler.java
80,82c80,82
< * @see
#isEntityCmp(com.sun.javadoc.ClassDoc)
< * @see
#isPersistentField(com.sun.javadoc.MethodDoc)
< * @see #isGetter(java.lang.String)
---
> * @see
CmpTagsHandler#isEntityCmp(com.sun.javadoc.ClassDoc,xdoclet.DocletContext)
> * @see
PersistentTagsHandler#isPersistentField(com.sun.javadoc.MethodDoc)
> * @see
MethodTagsHandler#isGetter(java.lang.String)
Index: core/src/xdoclet/ejb/tags/UtilTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/ejb/tags/UtilTagsHandler.java,v
retrieving revision 1.3
diff -r1.3 UtilTagsHandler.java
34,35c34,35
< * Similar to {@link #getComponentInterface}. Relies on the
ejb:home tag,
< * which has the following relevant properties:
---
> * Similar to {@link InterfaceTagsHandler#getComponentInterface}.
Relies on
> * the ejb:home tag, which has the following relevant properties:
cvs server: Diffing core/src/xdoclet/ejb/tags/vendor
cvs server: Diffing core/src/xdoclet/ejb/vendor
cvs server: Diffing core/src/xdoclet/jmx
cvs server: Diffing core/src/xdoclet/tags
Index: core/src/xdoclet/tags/AbstractProgramElementTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tags/AbstractProgramElementTagsH
andler.java,v
retrieving revision 1.3
diff -r1.3 AbstractProgramElementTagsHandler.java
206,207c206,207
< * @see
#classTagValue(java.util.Properties)
< * @see
#methodTagValue(java.util.Properties)
---
> * @see
ClassTagsHandler#classTagValue(java.util.Properties)
> * @see
MethodTagsHandler#methodTagValue(java.util.Properties)
356c356
< * A utility method to get the black space characters used for
indenting
---
> * A utility method to get the blank space characters used for
indenting
361,363c361,362
< * @see #methodComment()
< * @see #classComment()
< * @see #comment()
---
> * @see
MethodTagsHandler#methodComment(java.util.Properties)
> * @see
ClassTagsHandler#classComment(java.util.Properties)
Index: core/src/xdoclet/tags/ClassTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tags/ClassTagsHandler.java,v
retrieving revision 1.3
diff -r1.3 ClassTagsHandler.java
569c569
< * @see
#methodComment(java.util.Properties)
---
> * @see
MethodTagsHandler#methodComment(java.util.Properties)
Index: core/src/xdoclet/tags/MergeTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tags/MergeTagsHandler.java,v
retrieving revision 1.2
diff -r1.2 MergeTagsHandler.java
98c98
< * @see #symbolicClassName()
---
> * @see
ClassTagsHandler#symbolicClassName()
155,156c155,156
< * @see
xdoclet.util.TemplateEngine#setTemplateFile(java.io.File)
< * @see
xdoclet.util.TemplateEngine#currentLineNum
---
> * @see
xdoclet.template.TemplateEngine#setTemplateFile(java.io.File)
> * @see
xdoclet.template.TemplateEngine#currentLineNum
Index: core/src/xdoclet/tags/MethodTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tags/MethodTagsHandler.java,v
retrieving revision 1.4
diff -r1.4 MethodTagsHandler.java
84c84
< * @see
#classComment(java.util.Properties)
---
> * @see
ClassTagsHandler#classComment(java.util.Properties)
Index: core/src/xdoclet/tags/TypeTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tags/TypeTagsHandler.java,v
retrieving revision 1.2
diff -r1.2 TypeTagsHandler.java
280c280
< * @see
#forAllClasses(java.lang.String,java.util.Properties)
---
> * @see
ClassTagsHandler#forAllClasses(java.lang.String,java.util.Properties)
cvs server: Diffing core/src/xdoclet/template
Index: core/src/xdoclet/template/TemplateContext.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/template/TemplateContext.java,v
retrieving revision 1.2
diff -r1.2 TemplateContext.java
15c15
< * @see #init(xdoclet.DocletContext,com.sun.javadoc.RootDoc)
---
> * @see xdoclet.TemplateSubTask#init(xdoclet.DocletContext)
Index: core/src/xdoclet/template/TemplateEngine.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/template/TemplateEngine.java,v
retrieving revision 1.2
diff -r1.2 TemplateEngine.java
18c18
< * <XDoclet:blabla>strings, just like JSP tag libraries. There's no
support for
---
> * <XDoclet:blabla> strings, just like JSP tag libraries. There's no
support for
34,36c34,36
< * The PrintWriter used for outputing the generated stuff.
< * xdoclet.util.PrettyPrintWriter tries to pretty format the
generated file by
< * removing redundant spaces/lines.
---
> * The PrintWriter used for outputing the generated stuff. {@link
> * xdoclet.template.PrettyPrintWriter} tries to pretty format the
generated
> * file by removing redundant spaces/lines.
38c38
< * @see xdoclet.util.PrettyPrintWriter
---
> * @see xdoclet.template.PrettyPrintWriter
cvs server: Diffing core/src/xdoclet/util
cvs server: Diffing core/src/xdoclet/util/serialveruid
cvs server: Diffing core/src/xdoclet/web
cvs server: Diffing core/src/xdoclet/web/vendor
cvs server: Diffing core/src/xdoclet/web/vendor/webwork
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
