You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by vg...@apache.org on 2007/12/29 06:36:50 UTC
svn commit: r607379 - in
/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon:
generation/ reading/ serialization/ transformation/
Author: vgritsenko
Date: Fri Dec 28 21:36:49 2007
New Revision: 607379
URL: http://svn.apache.org/viewvc?rev=607379&view=rev
Log:
fixing javadocs
Modified:
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGeneratorBean.java
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ExceptionGenerator.java
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FragmentExtractorGenerator.java
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/TraversableGenerator.java
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathTraversableGenerator.java
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ImageReader.java
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ResourceReader.java
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/TextSerializer.java
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/ZipArchiveSerializer.java
cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FragmentExtractorTransformer.java
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGeneratorBean.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGeneratorBean.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGeneratorBean.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGeneratorBean.java Fri Dec 28 21:36:49 2007
@@ -38,7 +38,6 @@
import org.xml.sax.SAXException;
/**
- * @cocoon.sitemap.component.documentation
* A simple parser converting a Comma Separated Values (CSV) file into XML.
*
* <p>This parser is controlled by the following sitemap parameters:</p>
@@ -99,6 +98,11 @@
* Unfortunately no official CSV specification has ever been published by
* any standard body, so the interpretation of the format might be slightly
* different in cases.</p>
+ *
+ * @cocoon.sitemap.component.documentation
+ * A simple parser converting a Comma Separated Values (CSV) file into XML.
+ *
+ * @version $Id$
*/
public class CSVGeneratorBean extends FileGeneratorBean {
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ExceptionGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ExceptionGenerator.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ExceptionGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ExceptionGenerator.java Fri Dec 28 21:36:49 2007
@@ -39,7 +39,6 @@
import java.util.Map;
/**
- * @cocoon.sitemap.component.documentation
* A generator that dumps an XML representation of the exception raised during
* pipeline execution.
*
@@ -80,6 +79,10 @@
* </ex:full-stacktrace>
* </ex:exception-report>
* </pre>
+ *
+ * @cocoon.sitemap.component.documentation
+ * A generator that dumps an XML representation of the exception raised during
+ * pipeline execution.
*
* @since 2.1.8
* @version $Id$
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FragmentExtractorGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FragmentExtractorGenerator.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FragmentExtractorGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FragmentExtractorGenerator.java Fri Dec 28 21:36:49 2007
@@ -33,14 +33,19 @@
/**
* @cocoon.sitemap.component.documentation
* The generation half of FragmentExtractor (see also <code>FragmentExtractorTransformer)</code>.
- * FragmentExtractor is a transformer-generator pair which is designed to allow
+ *
+ * <p>FragmentExtractor is a transformer-generator pair which is designed to allow
* sitemap managers to extract certain nodes from a SAX stream and move them
* into a separate pipeline. The main use for this is to extract inline SVG
* images and serve them up through a separate pipeline, usually serializing
* them to PNG or JPEG format first.
*
- * This is by no means complete yet, but it should prove useful, particularly
+ * <p>This is by no means complete yet, but it should prove useful, particularly
* for offline generation.
+ *
+ * @cocoon.sitemap.component.documentation
+ * The generation half of FragmentExtractor (see also <code>FragmentExtractorTransformer)</code>.
+ * @cocoon.sitemap.component.documentation.caching Yes
*
* @version $Id$
*/
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/TraversableGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/TraversableGenerator.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/TraversableGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/TraversableGenerator.java Fri Dec 28 21:36:49 2007
@@ -51,7 +51,6 @@
import org.xml.sax.helpers.AttributesImpl;
/**
- * @cocoon.sitemap.component.documentation
* Generates an XML source hierarchy listing from a Traversable Source.
*
* <p>
@@ -99,6 +98,10 @@
* for changed content. Defaults to 1 second.
* </dl>
* </p>
+ *
+ * @cocoon.sitemap.component.documentation
+ * Generates an XML source hierarchy listing from a Traversable Source.
+ * @cocoon.sitemap.component.documentation.caching Yes
*
* @version $Id$
*/
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathTraversableGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathTraversableGenerator.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathTraversableGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathTraversableGenerator.java Fri Dec 28 21:36:49 2007
@@ -44,9 +44,9 @@
import org.xml.sax.helpers.AttributesImpl;
/**
- * @cocoon.sitemap.component.documentation
* Generates an XML collection listing performing XPath queries on XML sources.
- * It can be used both as a plain TraversableGenerator or, if an XPath is
+ *
+ * <p>It can be used both as a plain TraversableGenerator or, if an XPath is
* specified, it will perform an XPath query on every XML resource, where "xml
* resource" is, by default, any resource ending with ".xml", which can be
* overriden by setting the (regexp) pattern "xmlFiles as a sitemap parameter,
@@ -94,6 +94,10 @@
* If you need to use namespaces, you can set them as sitemap parameters in
* the form:
* lt;map:parameter name="xmlns:<i>your prefix</i>" value="nsURI"/**">
+ *
+ * @cocoon.sitemap.component.documentation
+ * Generates an XML collection listing performing XPath queries on XML sources.
+ * @cocoon.sitemap.component.documentation.caching Yes
*
* @version $Id$
*/
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ImageReader.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ImageReader.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ImageReader.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ImageReader.java Fri Dec 28 21:36:49 2007
@@ -42,13 +42,12 @@
import com.sun.image.codec.jpeg.JPEGImageEncoder;
/**
- * @cocoon.sitemap.component.documentation
* The <code>ImageReader</code> component is used to serve binary image data
* in a sitemap pipeline. It makes use of HTTP Headers to determine if
* the requested resource should be written to the <code>OutputStream</code>
* or if it can signal that it hasn't changed.
*
- * Parameters:
+ * <p>Parameters:
* <dl>
* <dt><width></dt>
* <dd> This parameter is optional. When specified, it determines the
@@ -90,6 +89,13 @@
* compression is used. The range is 0.0 to 1.0, if specified.
* </dd>
* </dl>
+ *
+ * @cocoon.sitemap.component.documentation
+ * The <code>ImageReader</code> component is used to serve binary image data
+ * in a sitemap pipeline. It makes use of HTTP Headers to determine if
+ * the requested resource should be written to the <code>OutputStream</code>
+ * or if it can signal that it hasn't changed.
+ * @cocoon.sitemap.component.documentation.caching Yes
*
* @version $Id$
*/
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ResourceReader.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ResourceReader.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ResourceReader.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/reading/ResourceReader.java Fri Dec 28 21:36:49 2007
@@ -45,12 +45,11 @@
import org.xml.sax.SAXException;
/**
- * @version $Id$
- * @cocoon.sitemap.component.documentation The <code>ResourceReader</code> component is used to serve binary data
+ * The <code>ResourceReader</code> component is used to serve binary data
* in a sitemap pipeline. It makes use of HTTP Headers to determine if
* the requested resource should be written to the <code>OutputStream</code>
* or if it can signal that it hasn't changed.
- * <p/>
+ *
* <p>Configuration:
* <dl>
* <dt><expires></dt>
@@ -71,16 +70,25 @@
* broken/interrupted downloads).
* Defaults to true.
* </dl>
- * <p/>
+ *
* <p>Default configuration:
* <pre>
* <expires>-1</expires>
* <quick-modified-test>false</quick-modified-test>
* <byte-ranges>true</byte-ranges>
* </pre>
- * <p/>
+ *
* <p>In addition to reader configuration, above parameters can be passed
* to the reader at the time when it is used.
+ *
+ * @cocoon.sitemap.component.documentation
+ * The <code>ResourceReader</code> component is used to serve binary data
+ * in a sitemap pipeline. It makes use of HTTP Headers to determine if
+ * the requested resource should be written to the <code>OutputStream</code>
+ * or if it can signal that it hasn't changed.
+ * @cocoon.sitemap.component.documentation.caching Yes
+ *
+ * @version $Id$
*/
public class ResourceReader extends AbstractReader
implements CacheableProcessingComponent, Configurable {
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/TextSerializer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/TextSerializer.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/TextSerializer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/TextSerializer.java Fri Dec 28 21:36:49 2007
@@ -31,15 +31,20 @@
import java.io.OutputStream;
/**
- * @cocoon.sitemap.component.documentation
* Text serializer converts XML into plain text.
* It omits all XML tags and writes only character events to the output.
- * Internally, text serializer uses XML serializer with {@link OutputKeys#METHOD}
+ *
+ * <p>Internally, text serializer uses XML serializer with {@link OutputKeys#METHOD}
* set to <code>text</code>.
*
* <p>Input document must have at least one element - root element - which
* should wrap all the text inside it.
*
+ * @cocoon.sitemap.component.documentation
+ * Text serializer converts XML into plain text.
+ * It omits all XML tags and writes only character events to the output.
+ * @cocoon.sitemap.component.documentation.caching Yes
+ *
* @version $Id$
*/
public class TextSerializer extends AbstractTextSerializer {
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/ZipArchiveSerializer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/ZipArchiveSerializer.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/ZipArchiveSerializer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/ZipArchiveSerializer.java Fri Dec 28 21:36:49 2007
@@ -35,7 +35,6 @@
import org.xml.sax.helpers.NamespaceSupport;
/**
- * @cocoon.sitemap.component.documentation
* A serializer that builds Zip archives by aggregating several sources.
*
* <p>
@@ -67,6 +66,10 @@
* </zip:entry>
* </zip:archive:zip>
* </pre>
+ *
+ * @cocoon.sitemap.component.documentation
+ * A serializer that builds Zip archives by aggregating several sources.
+ * @cocoon.sitemap.component.documentation.caching Not Implemented
*
* @version $Id$
*/
Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FragmentExtractorTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FragmentExtractorTransformer.java?rev=607379&r1=607378&r2=607379&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FragmentExtractorTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FragmentExtractorTransformer.java Fri Dec 28 21:36:49 2007
@@ -47,12 +47,12 @@
import org.xml.sax.helpers.AttributesImpl;
/**
- * @cocoon.sitemap.component.documentation
* The transformation half of the FragmentExtractor (see also <code>FragmentExtractorGenerator</code>.
- * This transformer recieves an incoming stream of xml and replaces
+ *
+ * <p>This transformer recieves an incoming stream of xml and replaces
* fragments with an fragment extractor locator pointing to the fragments.
*
- * The extracted fragments are identified by their element name and namespace URI.
+ * <p>The extracted fragments are identified by their element name and namespace URI.
* The default is to extract SVG images ("svg" elements in namespace
* "http://www.w3.org/2000/svg"), but this can be overriden in the configuration:
* <pre>
@@ -65,10 +65,15 @@
* <fe:fragment xmlns:fe="http://apache.org/cocoon/fragmentextractor/2.0" fragment-id="..."/>
* </pre>
*
+ * @cocoon.sitemap.component.documentation
+ * The transformation half of the FragmentExtractor (see also <code>FragmentExtractorGenerator</code>.
+ * @cocoon.sitemap.component.documentation.caching Yes
+ *
* @version $Id$
*/
public class FragmentExtractorTransformer extends AbstractTransformer
- implements CacheableProcessingComponent, Configurable, Serviceable, Disposable {
+ implements CacheableProcessingComponent, Configurable,
+ Serviceable, Disposable {
public static final String FE_URI = "http://apache.org/cocoon/fragmentextractor/2.0";