cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From anto...@apache.org
Subject svn commit: r367009 - /cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/
Date Sun, 08 Jan 2006 08:30:52 GMT
Author: antonio
Date: Sun Jan  8 00:30:46 2006
New Revision: 367009

URL: http://svn.apache.org/viewcvs?rev=367009&view=rev
Log:
Fix javadocs. Add @version. Set final to static 2 constants.

Modified:
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ContextPathModule.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/DefaultsModule.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java
    cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java?rev=367009&r1=367008&r2=367009&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java
(original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java
Sun Jan  8 00:30:46 2006
@@ -31,7 +31,7 @@
  * instance, if called within a <map:match pattern="a/b/c.xsp"> pipeline,
  * <code>{baselink:SitemapBaseLink}</code> would evaluate to <code>../../</code>.
  *
- * based on RequestURIModule
+ * based on {@link RequestURIModule}
  *
  */
 public class BaseLinkModule extends AbstractInputModule implements ThreadSafe {

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ContextPathModule.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ContextPathModule.java?rev=367009&r1=367008&r2=367009&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ContextPathModule.java
(original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ContextPathModule.java
Sun Jan  8 00:30:46 2006
@@ -54,19 +54,21 @@
  * </p>
  * <p>
  * <pre>
- * <map:transform src="skins/{forrest:skin}/xslt/fo/document2fo.xsl">
- *    <map:parameter name="basedir" value="{contextpath:resources}/"/>
- * </map:transform>
+ * &lt;map:transform src=&quot;skins/{forrest:skin}/xslt/fo/document2fo.xsl&quot;&gt;
+ *    &lt;map:parameter name=&quot;basedir&quot; value=&quot;{contextpath:resources}/&quot;/&gt;
+ * &lt;/map:transform&gt;
+ * </pre>
  *
  * And then prepend this to all image paths:
+ * <pre>
  *  ...
- *  <xsl:param name="basedir" select="''"/>
+ *  &lt;xsl:param name=&quot;basedir&quot; select=&quot;&apos;&apos;&quot;/&gt;
  *  ...
- *  <xsl:template match="img">
- *      <xsl:variable name="imgpath" select="concat($basedir, @src)"/>
- *      <fo:external-graphic src="{$imgpath}" ...
+ *  &lt;xsl:template match=&quot;img&quot;&gt;
+ *      &lt;xsl:variable name=&quot;imgpath&quot; select=&quot;concat($basedir,
@src)&quot;/&gt;
+ *      &lt;fo:external-graphic src=&quot;{$imgpath}&quot; ...
  *      ...
- *  </xsl:template>
+ *  &lt;/xsl:template&gt;
  *  </pre>
  *  </p>
  *

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/DefaultsModule.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/DefaultsModule.java?rev=367009&r1=367008&r2=367009&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/DefaultsModule.java
(original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/DefaultsModule.java
Sun Jan  8 00:30:46 2006
@@ -33,12 +33,14 @@
  * another module, combine this one with the ChainMetaModule and an
  * arbitrary number of other modules.
  *
+ * <pre>
  * &lt;values&gt;
  *  &lt;skin&gt;myskin&lt;/skin&gt;
  *  &lt;base&gt;baseurl&lt;/base&gt;
  *  ...
  * &lt;/values&gt;
- *
+ * </pre>
+ * 
  * @version $Id$
  */
 public class DefaultsModule extends AbstractLogEnabled

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java?rev=367009&r1=367008&r2=367009&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java
(original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java
Sun Jan  8 00:30:46 2006
@@ -34,43 +34,46 @@
  * ProjectPathModule provides relative and absolute paths with regards to the root of a project.
  * <p>Config:
  * <pre>
- *    <component-instance logger="core.modules.input"
- *           name="myproject"
- *           class="org.apache.cocoon.components.modules.input.ProjectPathModule">
- *      	<uri-prefix>my/project/</uri-prefix>
- *    </component-instance>
+ *    &lt;component-instance logger=&quot;core.modules.input&quot;
+ *           name=&quot;myproject&quot;
+ *           class=&quot;org.apache.cocoon.components.modules.input.ProjectPathModule&quot;&gt;
+ *          &lt;uri-prefix&gt;my/project/&lt;/uri-prefix&gt;
+ *    &lt;/component-instance&gt;
  * </pre>
  * </p>
  * <p>Usage:
  * <pre>
- * <map:transform src="skins/{forrest:skin}/xslt/fo/document2html.xsl">
- *    <map:parameter name="base" value="{myproject:relative}"/>
- * </map:transform>
- *
+ *    &lt;map:transform src=&quot;skins/{forrest:skin}/xslt/fo/document2html.xsl&quot;&gt;
+ *       &lt;map:parameter name=&quot;base&quot; value=&quot;{myproject:relative}&quot;/&gt;
+ *    &lt;/map:transform&gt;
+ *</pre>
  * And then prepend this to all image paths:
+ * <pre>
  *  ...
- *  <xsl:param name="base"/>
+ *  &lt;xsl:param name=&quot;base&quot;/&gt;
  *  ...
- *  <xsl:template match="img">
- *      <img src="{concat($base, @src)}" ...
+ *  &lt;xsl:template match=&quot;img&quot;&gt;
+ *      &lt;img src=&quot;{concat($base, @src)}&quot; ...
  *      ...
- *  </xsl:template>
+ *  &lt;/xsl:template&gt;
  *  </pre>
  * Then if you are in my/project/some/folder/page.html, the image will have a relative path
bact to the root of the project.
  * <pre>
- *   <img src="../../imagename.png"/>
+ *   &lt;img src=&quot;../../imagename.png&quot;/&gt;
  * </pre>
  * Using 'myproject:path' would have given you: /some/folder/page.html<br/>
  * Using 'myproject:folder' would have given you: /some/folder/
  * </p>
+ * 
+ * @version $Id$
  *
  */
 public class ProjectPathModule
     extends AbstractInputModule
     implements Configurable, ThreadSafe {
 
-    protected static String PROJECT_PARAM_NAME = "uri-prefix";
-    protected static String PROJECT_PARAM_DEFAULT = "/";
+    protected static final String PROJECT_PARAM_NAME = "uri-prefix";
+    protected static final String PROJECT_PARAM_DEFAULT = "/";
 
     protected String projectBase;
 	

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java?rev=367009&r1=367008&r2=367009&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java
(original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java
Sun Jan  8 00:30:46 2006
@@ -38,6 +38,7 @@
  *  is resolved via the SourceResolver system.
  * </p>
  *
+ * @version $Id$
  */
 public class PropertiesFileModule extends AbstractJXPathModule
 implements InputModule, Serviceable, Configurable, ThreadSafe {

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java?rev=367009&r1=367008&r2=367009&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java
(original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java
Sun Jan  8 00:30:46 2006
@@ -30,6 +30,8 @@
  * &lt;map:generate src="http://remote/page?param1={url-encode:{request-param:param1}}"/&gt;<br/>
  * Module configuration takes only one configuration parameter:
  * "encoding" which is a target string encoding. This is utf-8 by default.
+ * 
+ * @version $Id$
  */
 public final class URLDecodeModule extends AbstractInputModule
                                    implements ThreadSafe {

Modified: cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java
URL: http://svn.apache.org/viewcvs/cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java?rev=367009&r1=367008&r2=367009&view=diff
==============================================================================
--- cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java
(original)
+++ cocoon/trunk/cocoon-core/src/main/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java
Sun Jan  8 00:30:46 2006
@@ -30,6 +30,8 @@
  * &lt;map:generate src="http://remote/page?param1={url-encode:{request-param:param1}}"/&gt;<br/>
  * Module configuration takes only one configuration parameter:
  * "encoding" which is a target string encoding. This is utf-8 by default.
+ * 
+ * @version $Id$
  */
 public final class URLEncodeModule extends AbstractInputModule
                                    implements ThreadSafe {



Mime
View raw message