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:39:07 UTC
svn commit: r607380 - in /cocoon/trunk/core:
cocoon-core/src/main/java/org/apache/cocoon/acting/
cocoon-core/src/main/java/org/apache/cocoon/matching/
cocoon-core/src/main/java/org/apache/cocoon/sitemap/
cocoon-core/src/main/java/org/apache/cocoon/tran...
Author: vgritsenko
Date: Fri Dec 28 21:39:06 2007
New Revision: 607380
URL: http://svn.apache.org/viewvc?rev=607380&view=rev
Log:
fixing javadocs
Modified:
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/CopySourceAction.java
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/LocaleAction.java
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/matching/LocaleMatcher.java
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/sitemap/NotifyingGenerator.java
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/helpers/PreemptiveLoaderAction.java
cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGenerator.java
cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGeneratorBean.java
cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/components/LinkRewriterReader.java
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/CopySourceAction.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/CopySourceAction.java?rev=607380&r1=607379&r2=607380&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/CopySourceAction.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/CopySourceAction.java Fri Dec 28 21:39:06 2007
@@ -31,7 +31,6 @@
import org.apache.excalibur.source.TraversableSource;
/**
- * @cocoon.sitemap.component.documentation
* The CopySourceAction copies the content of it's "src" attribute to its "dest" parameter.
* The destination must of course resolve to a <code>WriteableSource</code>
*
@@ -43,6 +42,10 @@
* .../...
* </map:act>
*</pre>
+ *
+ * @cocoon.sitemap.component.documentation
+ * The CopySourceAction copies the content of it's "src" attribute to its "dest" parameter.
+ * The destination must of course resolve to a <code>WriteableSource</code>
*
* @version $Id$
*/
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/LocaleAction.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/LocaleAction.java?rev=607380&r1=607379&r2=607380&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/LocaleAction.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/acting/LocaleAction.java Fri Dec 28 21:39:06 2007
@@ -31,7 +31,6 @@
import java.util.Map;
/**
- * @cocoon.sitemap.component.documentation
* An action that locates and provides to the pipeline locale information
* looked up in a range of ways.
*
@@ -112,6 +111,10 @@
* <li>{country}: The country of the found locale</li>
* <li>{variant}: The variant of the found locale</li>
* </ul>
+ *
+ * @cocoon.sitemap.component.documentation
+ * An action that locates and provides to the pipeline locale information
+ * looked up in a range of ways.
*
* @version $Id$
*/
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/matching/LocaleMatcher.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/matching/LocaleMatcher.java?rev=607380&r1=607379&r2=607380&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/matching/LocaleMatcher.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/matching/LocaleMatcher.java Fri Dec 28 21:39:06 2007
@@ -38,7 +38,6 @@
import org.apache.cocoon.util.AbstractLogEnabled;
/**
- * @cocoon.sitemap.component.documentation
* A matcher that locates and identifies to the pipeline a source document to
* be used as the content for an i18n site, based upon a locale provided in a
* range of ways.
@@ -143,6 +142,11 @@
* <li>{country}: The country of the matching resource</li>
* <li>{variant}: The variant of the matching resource</li>
* </ul>
+ *
+ * @cocoon.sitemap.component.documentation
+ * A matcher that locates and identifies to the pipeline a source document to
+ * be used as the content for an i18n site, based upon a locale provided in a
+ * range of ways.
*
* @since 2.1.6
* @version $Id$
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/sitemap/NotifyingGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/sitemap/NotifyingGenerator.java?rev=607380&r1=607379&r2=607380&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/sitemap/NotifyingGenerator.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/sitemap/NotifyingGenerator.java Fri Dec 28 21:39:06 2007
@@ -35,7 +35,7 @@
* Generates an XML representation of the current notification.
*
* @cocoon.sitemap.component.documentation
- * Generates an XML representation of the current notification.
+ * Deprecated. Generates an XML representation of the current notification.
* @cocoon.sitemap.component.documentation.caching No
*
* @deprecated Use <map:handle-errors> without type attribute together with
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/helpers/PreemptiveLoaderAction.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/helpers/PreemptiveLoaderAction.java?rev=607380&r1=607379&r2=607380&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/helpers/PreemptiveLoaderAction.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/helpers/PreemptiveLoaderAction.java Fri Dec 28 21:39:06 2007
@@ -25,10 +25,12 @@
import org.apache.cocoon.environment.SourceResolver;
/**
+ * This action starts the preemptive loader and runs forever.
+ *
* @cocoon.sitemap.component.documentation
* This action starts the preemptive loader and runs forever.
*
- * @since 2.1
+ * @since 2.1
* @version $Id$
*/
public class PreemptiveLoaderAction extends ServiceableAction
Modified: cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGenerator.java?rev=607380&r1=607379&r2=607380&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGenerator.java (original)
+++ cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGenerator.java Fri Dec 28 21:39:06 2007
@@ -20,30 +20,37 @@
import java.util.Map;
import org.apache.avalon.framework.parameters.Parameters;
+
import org.apache.cocoon.ProcessingException;
import org.apache.cocoon.environment.SourceResolver;
-import org.apache.cocoon.generation.FileGenerator;
+
import org.xml.sax.SAXException;
/**
- * @cocoon.sitemap.component.documentation
* This generator extends the usual FileGenerator with a pause parameter.
* During generation of the content, this generator pauses for the given
* amount of time.
- * This is very usefull for caching tests.
+ *
+ * <p>This is very usefull for caching tests.
*
- * @version $Id$
- * @since 2.1
+ * @cocoon.sitemap.component.documentation
+ * This generator extends the usual FileGenerator with a pause parameter.
+ * During generation of the content, this generator pauses for the given
+ * amount of time.
+ * @cocoon.sitemap.component.documentation.caching No
+ *
+ * @since 2.1
+ * @version $Id$
*/
-public class PauseGenerator
- extends FileGenerator {
+public class PauseGenerator extends FileGenerator {
protected long secs;
/**
- * @see org.apache.cocoon.generation.FileGenerator#setup(org.apache.cocoon.environment.SourceResolver, java.util.Map, java.lang.String, org.apache.avalon.framework.parameters.Parameters)
+ * @see org.apache.cocoon.generation.FileGenerator#setup
*/
- public void setup(SourceResolver resolver, Map objectModel, String src, Parameters par) throws ProcessingException, SAXException, IOException {
+ public void setup(SourceResolver resolver, Map objectModel, String src, Parameters par)
+ throws ProcessingException, SAXException, IOException {
super.setup(resolver, objectModel, src, par);
this.secs = par.getParameterAsLong("pause", 60);
}
@@ -53,19 +60,18 @@
*/
public void generate()
throws IOException, SAXException, ProcessingException {
- if ( this.getLogger().isDebugEnabled() ) {
- this.getLogger().debug("Waiting for " + secs + " secs.");
+ if (getLogger().isDebugEnabled() ) {
+ getLogger().debug("Waiting for " + secs + " secs.");
}
try {
Thread.sleep(secs * 1000);
} catch (InterruptedException ie) {
// ignore
}
- if ( this.getLogger().isDebugEnabled() ) {
- this.getLogger().debug("Finished waiting.");
+
+ if (getLogger().isDebugEnabled() ) {
+ getLogger().debug("Finished waiting.");
}
super.generate();
}
-
-
}
Modified: cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGeneratorBean.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGeneratorBean.java?rev=607380&r1=607379&r2=607380&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGeneratorBean.java (original)
+++ cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/generation/PauseGeneratorBean.java Fri Dec 28 21:39:06 2007
@@ -25,13 +25,19 @@
import org.xml.sax.SAXException;
/**
- * @cocoon.sitemap.component.documentation
* This generator extends the usual FileGenerator with a pause parameter.
* During generation of the content, this generator pauses for the given
- * amount of time (in seconds). This is very usefull for caching tests.
+ * amount of time (in seconds).
+ *
+ * <p>This is very usefull for caching tests.
*
- * @version $Id$
+ * @cocoon.sitemap.component.documentation
+ * This generator extends the usual FileGenerator with a pause parameter.
+ * During generation of the content, this generator pauses for the given
+ * amount of time (in seconds).
+ *
* @since 2.2
+ * @version $Id$
*/
public class PauseGeneratorBean extends FileGeneratorBean {
Modified: cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/components/LinkRewriterReader.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/components/LinkRewriterReader.java?rev=607380&r1=607379&r2=607380&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/components/LinkRewriterReader.java (original)
+++ cocoon/trunk/core/cocoon-servlet-service/cocoon-servlet-service-components/src/main/java/org/apache/cocoon/servletservice/components/LinkRewriterReader.java Fri Dec 28 21:39:06 2007
@@ -49,7 +49,6 @@
import org.xml.sax.SAXException;
/**
- * @cocoon.sitemap.component.documentation
* <code>LinkRewriterReader<code> implements <code>servlet:</code> link rewriting in
* text resources. It should be used especially for serving JavaScript files that have
* paths refering to other blocks (<code>servlet:</code> links).
@@ -57,6 +56,14 @@
* <p><b>Configuration</b><br>
* <code>encoding</code> - see {@link #setEncoding}<br>
* <code>expires</code> - see {@link #setExpires}.
+ *
+ * @cocoon.sitemap.component.documentation
+ * <code>LinkRewriterReader<code> implements <code>servlet:</code> link rewriting in
+ * text resources. It should be used especially for serving JavaScript files that have
+ * paths refering to other blocks (<code>servlet:</code> links).
+ * @cocoon.sitemap.component.documentation.caching Yes
+ *
+ * @version $Id$
*/
public class LinkRewriterReader extends AbstractReader
implements CacheableProcessingComponent {