svn commit: r1207610 - in /commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event: ConfigurationErrorEvent.java ConfigurationErrorListener.java ConfigurationEvent.java

[oh...@apache.org]

Author: oheger
Date: Mon Nov 28 21:06:22 2011
New Revision: 1207610

URL: http://svn.apache.org/viewvc?rev=1207610&view=rev
Log:
Java 1.5 compatibility: Javadocs.

Modified:
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationEvent.java

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java?rev=1207610&r1=1207609&r2=1207610&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java Mon Nov 28 21:06:22 2011
@@ -23,8 +23,8 @@ package org.apache.commons.configuration
  * </p>
  * <p>
  * Some configuration implementations (e.g.
- * <code>{@link org.apache.commons.configuration.DatabaseConfiguration}</code>
- * or <code>{@link org.apache.commons.configuration.JNDIConfiguration}</code>
+ * {@link org.apache.commons.configuration.DatabaseConfiguration}
+ * or {@link org.apache.commons.configuration.JNDIConfiguration}
  * use an underlying storage that can throw an exception on each property
  * access. In earlier versions of this library such exceptions were logged and
  * then silently ignored. This makes it impossible for a client to find out that
@@ -38,9 +38,9 @@ package org.apache.commons.configuration
  * internal errors related to the source configuration object.
  * </p>
  * <p>
- * By inheriting from <code>ConfigurationEvent</code> this event class
+ * By inheriting from {@code ConfigurationEvent} this event class
  * supports all properties that describe an operation on a configuration
- * instance. In addition a <code>Throwable</code> object is available
+ * instance. In addition a {@code Throwable} object is available
  * representing the occurred error. The event's type determines the operation
  * that caused the error. Note that depending on the event type and the occurred
  * exception not all of the other properties (e.g. name of the affected property
@@ -65,7 +65,7 @@ public class ConfigurationErrorEvent ext
     private Throwable cause;
 
     /**
-     * Creates a new instance of <code>ConfigurationErrorEvent</code> and
+     * Creates a new instance of {@code ConfigurationErrorEvent} and
      * initializes it.
      *
      * @param source the event source
@@ -82,7 +82,7 @@ public class ConfigurationErrorEvent ext
     }
 
     /**
-     * Returns the cause of this error event. This is the <code>Throwable</code>
+     * Returns the cause of this error event. This is the {@code Throwable}
      * object that caused this event to be fired.
      *
      * @return the cause of this error event

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java?rev=1207610&r1=1207609&r2=1207610&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java Mon Nov 28 21:06:22 2011
@@ -42,7 +42,7 @@ public interface ConfigurationErrorListe
     /**
      * Notifies this listener that in an observed configuration an error
      * occurred. All information available about this error, including the
-     * causing <code>Throwable</code> object, can be obtained from the passed
+     * causing {@code Throwable} object, can be obtained from the passed
      * in event object.
      *
      * @param event the event object with information about the error

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationEvent.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationEvent.java?rev=1207610&r1=1207609&r2=1207610&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationEvent.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/event/ConfigurationEvent.java Mon Nov 28 21:06:22 2011
@@ -48,19 +48,19 @@ import java.util.EventObject;
  * <p>
  * The following standard events are generated by typical configuration
  * implementations (the constants for the event types are defined in
- * <code>{@link org.apache.commons.configuration.AbstractConfiguration}</code>):
+ * {@link org.apache.commons.configuration.AbstractConfiguration}):
  * <dl>
  * <dt>EVENT_ADD_PROPERTY</dt>
- * <dd>This event is triggered for each call of the <code>addProperty()</code>
+ * <dd>This event is triggered for each call of the {@code addProperty()}
  * method of a configuration object. It contains the name of the property, to
  * which new data is added, and the value object that is added to this property
  * (this may be an array or a list if multiple values are added).</dd>
  * <dt>EVENT_SET_PROPERTY</dt>
- * <dd>Calling the <code>setProperty()</code> method triggers this event. The
+ * <dd>Calling the {@code setProperty()} method triggers this event. The
  * event object stores the name of the affected property and its new value.</dd>
  * <dt>EVENT_CLEAR_PROPERTY</dt>
  * <dd>If a property is removed from a configuration (by calling the
- * <code>clearProperty()</code> method), an event of this type is fired. In
+ * {@code clearProperty()} method), an event of this type is fired. In
  * this case the event object only stores the name of the removed property, the
  * value is <b>null</b>.</dd>
  * <dt>EVENT_CLEAR</dt>
@@ -95,7 +95,7 @@ public class ConfigurationEvent extends 
     private boolean beforeUpdate;
 
     /**
-     * Creates a new instance of <code>ConfigurationEvent</code> and
+     * Creates a new instance of {@code ConfigurationEvent} and
      * initializes it.
      *
      * @param source the event source