You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by cz...@apache.org on 2003/07/03 11:26:04 UTC
cvs commit: cocoon-2.1/src/blocks/asciiart/java/org/apache/cocoon/generation/asciiart AsciiArtPad.java
cziegeler 2003/07/03 02:26:04
Modified: src/blocks/xmlform/java/org/apache/cocoon/components/xmlform
Form.java
src/blocks/portal/java/org/apache/cocoon/portal/event/impl
ChangeAspectDataEvent.java
src/blocks/portal/java/org/apache/cocoon/portal/layout/impl
DefaultLayoutDescription.java
src/blocks/portal/java/org/apache/cocoon/portal/aspect/impl
DefaultAspectDescription.java
AbstractAspectalizableDescription.java
src/blocks/xmlform/java/org/apache/cocoon/components/validation/schematron
SchematronFactory.java
src/blocks/axis/java/org/apache/cocoon/webservices/instrument
InstrumentationService.java
src/blocks/batik/java/org/apache/cocoon/serialization
SVGSerializer.java
src/blocks/portal/java/org/apache/cocoon/portal/coplet/impl
DefaultCopletDescription.java
src/blocks/portal/java/org/apache/cocoon/portal/factory
ProducibleDescription.java
src/blocks/xmlform/java/org/apache/cocoon/acting
AbstractXMLFormAction.java
src/blocks/mail/java/org/apache/cocoon/acting Sendmail.java
src/blocks/mail/java/org/apache/cocoon/mail
MailMessageSender.java
src/blocks/qdox/java/org/apache/cocoon/components/source/impl
QDoxSource.java
src/blocks/asciiart/java/org/apache/cocoon/generation/asciiart
AsciiArtPad.java
Log:
Reducing javadocs errors
Revision Changes Path
1.5 +1 -2 cocoon-2.1/src/blocks/xmlform/java/org/apache/cocoon/components/xmlform/Form.java
Index: Form.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/xmlform/java/org/apache/cocoon/components/xmlform/Form.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Form.java 3 Jul 2003 08:27:46 -0000 1.4
+++ Form.java 3 Jul 2003 09:26:02 -0000 1.5
@@ -785,7 +785,6 @@
*
* @param viewName
*
- * @return
*/
protected FormViewState getFormViewState(String viewName) {
FormViewState formViewState = (FormViewState) viewStateMap_.get(viewName);
1.5 +4 -4 cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/event/impl/ChangeAspectDataEvent.java
Index: ChangeAspectDataEvent.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/event/impl/ChangeAspectDataEvent.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ChangeAspectDataEvent.java 28 May 2003 13:47:30 -0000 1.4
+++ ChangeAspectDataEvent.java 3 Jul 2003 09:26:02 -0000 1.5
@@ -80,21 +80,21 @@
}
/**
- * @return
+ * @return The aspect name
*/
public String getAspectName() {
return this.aspectName;
}
/**
- * @return
+ * @return The value to set
*/
public Object getData() {
return this.data;
}
/**
- * @return
+ * @return The target to change
*/
public Object getTarget() {
return this.target;
1.4 +1 -4 cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/DefaultLayoutDescription.java
Index: DefaultLayoutDescription.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/layout/impl/DefaultLayoutDescription.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DefaultLayoutDescription.java 14 Jun 2003 16:58:02 -0000 1.3
+++ DefaultLayoutDescription.java 3 Jul 2003 09:26:03 -0000 1.4
@@ -73,9 +73,6 @@
protected List rendererNames = new ArrayList(2);
- /**
- * @return
- */
public String getDefaultRendererName() {
return defaultRendererName;
}
1.4 +3 -3 cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/aspect/impl/DefaultAspectDescription.java
Index: DefaultAspectDescription.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/aspect/impl/DefaultAspectDescription.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DefaultAspectDescription.java 14 Jun 2003 17:55:43 -0000 1.3
+++ DefaultAspectDescription.java 3 Jul 2003 09:26:03 -0000 1.4
@@ -93,14 +93,14 @@
}
/**
- * @return
+ * @return The class name
*/
public String getClassName() {
return className;
}
/**
- * @return
+ * @return The configred name
*/
public String getName() {
return name;
1.4 +1 -4 cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/aspect/impl/AbstractAspectalizableDescription.java
Index: AbstractAspectalizableDescription.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/aspect/impl/AbstractAspectalizableDescription.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AbstractAspectalizableDescription.java 22 May 2003 12:32:47 -0000 1.3
+++ AbstractAspectalizableDescription.java 3 Jul 2003 09:26:03 -0000 1.4
@@ -70,9 +70,6 @@
protected List aspects = new ArrayList();
- /**
- * @return
- */
public List getAspectDescriptions() {
return this.aspects;
}
1.3 +1 -2 cocoon-2.1/src/blocks/xmlform/java/org/apache/cocoon/components/validation/schematron/SchematronFactory.java
Index: SchematronFactory.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/xmlform/java/org/apache/cocoon/components/validation/schematron/SchematronFactory.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SchematronFactory.java 26 Apr 2003 12:10:44 -0000 1.2
+++ SchematronFactory.java 3 Jul 2003 09:26:03 -0000 1.3
@@ -425,7 +425,6 @@
*
* @param path
*
- * @return
*/
protected String fixns(String path) {
// Ironicly, at the time I am writing this
1.2 +2 -2 cocoon-2.1/src/blocks/axis/java/org/apache/cocoon/webservices/instrument/InstrumentationService.java
Index: InstrumentationService.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/axis/java/org/apache/cocoon/webservices/instrument/InstrumentationService.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- InstrumentationService.java 9 Mar 2003 00:02:29 -0000 1.1
+++ InstrumentationService.java 3 Jul 2003 09:26:03 -0000 1.2
@@ -102,7 +102,7 @@
/**
* Obtains an array of instrumentable sample names
*
- * @return a {@link String[]} array of sample names
+ * @return a {@link String}[] array of sample names
*/
String[] getSampleNames();
}
1.7 +5 -5 cocoon-2.1/src/blocks/batik/java/org/apache/cocoon/serialization/SVGSerializer.java
Index: SVGSerializer.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/batik/java/org/apache/cocoon/serialization/SVGSerializer.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SVGSerializer.java 7 May 2003 19:15:02 -0000 1.6
+++ SVGSerializer.java 3 Jul 2003 09:26:03 -0000 1.7
@@ -260,7 +260,7 @@
/**
* Generate the unique key.
* This key must be unique inside the space of this component.
- * This method must be invoked before the generateValidity() method.
+ * This method must be invoked before the getValidity() method.
*
* @return The generated key or <code>0</code> if the component
* is currently not cacheable.
@@ -271,7 +271,7 @@
/**
* Generate the validity object.
- * Before this method can be invoked the generateKey() method
+ * Before this method can be invoked the getKey() method
* must be invoked.
*
* @return The generated validity object or <code>null</code> if the
@@ -285,9 +285,9 @@
* Returns true so the pipeline implementation will buffer generated
* output and write content length to the response.
* <p>Batik's PNGTranscoder closes the output stream, therefore we
- * cannot pass {@link #output} directly to Batik and have to
+ * cannot pass the output stream directly to Batik and have to
* instruct pipeline to buffer it. If we do not buffer, we would get
- * an exception when {@link org.apache.cocoon.Cocoon#process}
+ * an exception when {@link org.apache.cocoon.Cocoon#process(Environment)}
* tries to close the stream.
*/
public boolean shouldSetContentLength() {
1.2 +1 -4 cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/coplet/impl/DefaultCopletDescription.java
Index: DefaultCopletDescription.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/coplet/impl/DefaultCopletDescription.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DefaultCopletDescription.java 22 May 2003 12:32:47 -0000 1.1
+++ DefaultCopletDescription.java 3 Jul 2003 09:26:03 -0000 1.2
@@ -70,9 +70,6 @@
protected List instanceAspects = new ArrayList();
- /**
- * @return
- */
public List getInstanceAspectDescriptions() {
return this.instanceAspects;
}
1.3 +3 -3 cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/factory/ProducibleDescription.java
Index: ProducibleDescription.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/portal/factory/ProducibleDescription.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ProducibleDescription.java 6 Jun 2003 11:33:39 -0000 1.2
+++ ProducibleDescription.java 3 Jul 2003 09:26:03 -0000 1.3
@@ -63,12 +63,12 @@
extends AspectalizableDescription {
/**
- * @return
+ * @return The class name
*/
String getClassName();
/**
- * @return
+ * @return The configured name
*/
String getName();
1.4 +1 -4 cocoon-2.1/src/blocks/xmlform/java/org/apache/cocoon/acting/AbstractXMLFormAction.java
Index: AbstractXMLFormAction.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/xmlform/java/org/apache/cocoon/acting/AbstractXMLFormAction.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AbstractXMLFormAction.java 3 Jul 2003 08:27:47 -0000 1.3
+++ AbstractXMLFormAction.java 3 Jul 2003 09:26:03 -0000 1.4
@@ -263,7 +263,6 @@
* Get the command which was submitted with the form.
* It is extracted from the standard cocoon-action-* request parameter
*
- * @return
*/
public String getCommand() {
return command_;
@@ -319,8 +318,6 @@
* Semanticly similar to Struts Action.perform()
*
* Take appropriate action based on the command.
- *
- * @return
*/
public abstract Map perform();
1.2 +2 -2 cocoon-2.1/src/blocks/mail/java/org/apache/cocoon/acting/Sendmail.java
Index: Sendmail.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/mail/java/org/apache/cocoon/acting/Sendmail.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Sendmail.java 17 Apr 2003 20:30:03 -0000 1.1
+++ Sendmail.java 3 Jul 2003 09:26:03 -0000 1.2
@@ -109,7 +109,7 @@
* is assumed, that the argument describes a request parameter of an
* uploaded file, which
* Cocoon has internally turned into a
- * {@link org.apache.cocoon.components.request.multipart.FilePart}
+ * {@link Part}
* object.</dd>
* </dl>
* <p>
1.3 +2 -2 cocoon-2.1/src/blocks/mail/java/org/apache/cocoon/mail/MailMessageSender.java
Index: MailMessageSender.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/mail/java/org/apache/cocoon/mail/MailMessageSender.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- MailMessageSender.java 3 Jul 2003 08:00:00 -0000 1.2
+++ MailMessageSender.java 3 Jul 2003 09:26:03 -0000 1.3
@@ -349,7 +349,7 @@
}
/**
- * Accesses any Exception caught by {@link sendIt}.
+ * Accesses any Exception caught by {@link #sendIt(SourceResolver)}.
* @return AddressException or MessagingException
*/
public Exception getException() {
1.2 +3 -3 cocoon-2.1/src/blocks/qdox/java/org/apache/cocoon/components/source/impl/QDoxSource.java
Index: QDoxSource.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/qdox/java/org/apache/cocoon/components/source/impl/QDoxSource.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- QDoxSource.java 6 May 2003 08:49:59 -0000 1.1
+++ QDoxSource.java 3 Jul 2003 09:26:04 -0000 1.2
@@ -234,7 +234,7 @@
}
/**
- * @see org.apache.avalon.excalibur.xml.XMLizable#toSAX(org.xml.sax.ContentHandler)
+ * @see XMLizable#toSAX(org.xml.sax.ContentHandler)
* @throws SAXException if any error occurs during SAX outputting.
*/
public void toSAX(ContentHandler handler) throws SAXException {
@@ -335,7 +335,7 @@
}
/**
- * @see org.apache.excalibur.source.Recyclable#recycle()
+ * @see Recyclable#recycle()
*/
public void recycle() {
if (logger != null && logger.isDebugEnabled()) {
1.3 +1 -22 cocoon-2.1/src/blocks/asciiart/java/org/apache/cocoon/generation/asciiart/AsciiArtPad.java
Index: AsciiArtPad.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/asciiart/java/org/apache/cocoon/generation/asciiart/AsciiArtPad.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AsciiArtPad.java 11 Mar 2003 17:44:15 -0000 1.2
+++ AsciiArtPad.java 3 Jul 2003 09:26:04 -0000 1.3
@@ -202,9 +202,6 @@
/**
* An AsciiArtElement describing a line.
*
- *@author huber@apache.org
- *@created 18. Dezember 2002
- *@version CVS Version: $Id$
*/
public static class AsciiArtLine implements AsciiArtElement {
double xStart;
@@ -326,9 +323,6 @@
/**
* An AsciiArtElement describing a rectangle.
*
- *@author huber@apache.org
- *@created 21. Dezember 2002
- *@version CVS Version: $Id$
*/
public static class AsciiArtRect implements AsciiArtElement {
double xUpperLeft;
@@ -470,9 +464,6 @@
/**
* An AsciiArtElement describing a string of text.
*
- *@author huber@apache.org
- *@created 21. Dezember 2002
- *@version CVS Version: $Id$
*/
public static class AsciiArtString implements AsciiArtElement {
private double x;
@@ -571,9 +562,6 @@
/**
* Helper class describing a coordinate of AsciiArtPad elements.
*
- *@author huber@apache.org
- *@created 21. Dezember 2002
- *@version CVS Version: $Id$
*/
public static class AsciiArtCoordinate {
int x, y;
@@ -667,9 +655,6 @@
* Helper class containing the ascii text data,
* acting as input of an AsciiArtPad
*
- *@author huber@apache.org
- *@created 21. Dezember 2002
- *@version CVS Version: $Id$
*/
public static class AsciiArt {
private String[] s;
@@ -753,9 +738,6 @@
/**
* Builder of AsciiArtElements from an AsciiArt input.
*
- *@author huber@apache.org
- *@created 21. Dezember 2002
- *@version CVS Version: $Id$
*/
public static class AsciiArtPadBuilder {
private AsciiArtPad asciiArtPad;
@@ -951,9 +933,6 @@
/**
* Marker interface of objects addable to the AsciiArtPad
*
- *@author huber@apache.org
- *@created 22. Dezember 2002
- *@version CVS Version: $Id$
*/
public static interface AsciiArtElement {
}