commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ebo...@apache.org
Subject svn commit: r629860 - in /commons/proper/configuration/branches/configuration2_experimental: ./ src/main/java/org/apache/commons/configuration2/ xdocs/
Date Thu, 21 Feb 2008 16:40:55 GMT
Author: ebourg
Date: Thu Feb 21 08:40:54 2008
New Revision: 629860

URL: http://svn.apache.org/viewvc?rev=629860&view=rev
Log:
Added external links to the Javadoc
Minor javadoc update to add some @links
Updated the javadoc archive page with a link to the future 1.5 archive

Modified:
    commons/proper/configuration/branches/configuration2_experimental/pom.xml
    commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java
    commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/XMLPropertiesConfiguration.java
    commons/proper/configuration/branches/configuration2_experimental/xdocs/javadocarchive.xml

Modified: commons/proper/configuration/branches/configuration2_experimental/pom.xml
URL: http://svn.apache.org/viewvc/commons/proper/configuration/branches/configuration2_experimental/pom.xml?rev=629860&r1=629859&r2=629860&view=diff
==============================================================================
--- commons/proper/configuration/branches/configuration2_experimental/pom.xml (original)
+++ commons/proper/configuration/branches/configuration2_experimental/pom.xml Thu Feb 21 08:40:54
2008
@@ -351,8 +351,28 @@
             <tarLongFileMode>gnu</tarLongFileMode>
           </configuration>
         </plugin>
+
       </plugins>
     </build>
+
+    <reporting>
+      <plugins>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-javadoc-plugin</artifactId>
+          <configuration>
+            <linksource>true</linksource>
+            <links>
+              <link>http://java.sun.com/javase/6/docs/api</link>
+              <link>http://java.sun.com/javaee/5/docs/api/</link>
+              <link>http://commons.apache.org/lang/apidocs/</link>
+              <link>http://commons.apache.org/jxpath/apidocs/</link>
+              <link>http://commons.apache.org/beanutils/apidocs/</link>
+            </links>
+          </configuration>
+        </plugin>
+      </plugins>
+    </reporting>
 
     <properties>
       <maven.compile.source>1.5</maven.compile.source>

Modified: commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java?rev=629860&r1=629859&r2=629860&view=diff
==============================================================================
--- commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java
(original)
+++ commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java
Thu Feb 21 08:40:54 2008
@@ -26,7 +26,7 @@
 /**
  * Basic configuration classe. Stores the configuration data but does not
  * provide any load or save functions. If you want to load your Configuration
- * from a file use PropertiesConfiguration or XmlConfiguration.
+ * from a file use {@link PropertiesConfiguration} or {@link XMLConfiguration}.
  *
  * This class extends normal Java properties by adding the possibility
  * to use the same key many times concatenating the value strings

Modified: commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/XMLPropertiesConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/XMLPropertiesConfiguration.java?rev=629860&r1=629859&r2=629860&view=diff
==============================================================================
--- commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/XMLPropertiesConfiguration.java
(original)
+++ commons/proper/configuration/branches/configuration2_experimental/src/main/java/org/apache/commons/configuration2/XMLPropertiesConfiguration.java
Thu Feb 21 08:40:54 2008
@@ -38,8 +38,8 @@
 
 /**
  * This configuration implements the XML properties format introduced in Java
- * 5.0, see http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html.
- * An XML properties file looks like this:
+ * 5.0 (see {@link java.util.Properties}). An XML properties file looks like
+ * this:
  *
  * <pre>
  * &lt;?xml version="1.0"?>
@@ -52,14 +52,13 @@
  * &lt;/properties>
  * </pre>
  *
- * The Java 5.0 runtime is not required to use this class. The default encoding
- * for this configuration format is UTF-8. Note that unlike
- * <code>PropertiesConfiguration</code>, <code>XMLPropertiesConfiguration</code>
+ * The default encoding for this configuration format is UTF-8. Note that unlike
+ * {@link PropertiesConfiguration}, <code>XMLPropertiesConfiguration</code>
  * does not support includes.
  *
- * <em>Note:</em>Configuration objects of this type can be read concurrently
+ * <p><em>Note:</em> Configuration objects of this type can be read concurrently
  * by multiple threads. However if one of these threads modifies the object,
- * synchronization has to be performed manually.
+ * synchronization has to be performed manually.</p>
  *
  * @author Emmanuel Bourg
  * @author Alistair Young
@@ -69,7 +68,7 @@
 public class XMLPropertiesConfiguration extends PropertiesConfiguration
 {
     /**
-     * The default encoding (UTF-8 as specified by http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html)
+     * The default encoding (UTF-8 as specified by {@link java.util.Properties})
      */
     private static final String DEFAULT_ENCODING = "UTF-8";
 
@@ -172,10 +171,10 @@
             writer.println("  <comment>" + StringEscapeUtils.escapeXml(getHeader())
+ "</comment>");
         }
 
-        Iterator keys = getKeys();
+        Iterator<String> keys = getKeys();
         while (keys.hasNext())
         {
-            String key = (String) keys.next();
+            String key = keys.next();
             Object value = getProperty(key);
 
             if (value instanceof List)

Modified: commons/proper/configuration/branches/configuration2_experimental/xdocs/javadocarchive.xml
URL: http://svn.apache.org/viewvc/commons/proper/configuration/branches/configuration2_experimental/xdocs/javadocarchive.xml?rev=629860&r1=629859&r2=629860&view=diff
==============================================================================
--- commons/proper/configuration/branches/configuration2_experimental/xdocs/javadocarchive.xml
(original)
+++ commons/proper/configuration/branches/configuration2_experimental/xdocs/javadocarchive.xml
Thu Feb 21 08:40:54 2008
@@ -25,6 +25,8 @@
 
     <section name="Javadoc archive">
 
+      <p>Commons Configuration 1.5 (<a href="apidocs_1.5/index.html">javadoc</a>)</p>
+
       <p>Commons Configuration 1.4 (<a href="apidocs_1.4/index.html">javadoc</a>)</p>
 
       <p>Commons Configuration 1.3 (<a href="apidocs_1.3/index.html">javadoc</a>)</p>



Mime
View raw message