svn commit: r615170 - in /jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data: FileDataStore.java db/DbDataStore.java

[th...@apache.org]

Author: thomasm
Date: Fri Jan 25 02:36:57 2008
New Revision: 615170

URL: http://svn.apache.org/viewvc?rev=615170&view=rev
Log:
JCR-73 Improve Javadoc documentation

Modified:
    jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/FileDataStore.java
    jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/db/DbDataStore.java

Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/FileDataStore.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/FileDataStore.java?rev=615170&r1=615169&r2=615170&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/FileDataStore.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/FileDataStore.java Fri Jan 25 02:36:57 2008
@@ -33,13 +33,13 @@
  * Simple file-based data store. Data records are stored as normal files
  * named using a message digest of the contained binary stream.
  * 
- * Configuration:<br>
- * <ul>
- * <li>&lt;param name="className" value="org.apache.jackrabbit.core.data.FileDataStore"/>
- * <li>&lt;param name="{@link #setPath(String) path}" value="/data/datastore"/>
- * <li>&lt;param name="{@link #setMinRecordLength(int) minRecordLength}" value="1024"/>
- * </ul>
- * 
+ * Configuration:
+ * <pre>
+ * &lt;DataStore class="org.apache.jackrabbit.core.data.FileDataStore">
+ *     &lt;param name="{@link #setPath(String) path}" value="/data/datastore"/>
+ *     &lt;param name="{@link #setMinRecordLength(int) minRecordLength}" value="1024"/>
+ * &lt/DataStore>
+ * </pre>
  * <p>
  * If the directory is not set, the directory &lt;repository home&gt;/repository/datastore is used.
  * <p>

Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/db/DbDataStore.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/db/DbDataStore.java?rev=615170&r1=615169&r2=615170&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/db/DbDataStore.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/data/db/DbDataStore.java Fri Jan 25 02:36:57 2008
@@ -49,19 +49,19 @@
 /**
  * A data store implementation that stores the records in a database using JDBC.
  * 
- * Configuration:<br>
- * <ul>
- * <li>&lt;param name="className" value="org.apache.jackrabbit.core.data.db.DbDataStore"/>
- * <li>&lt;param name="{@link #setUrl(String) url}" value="jdbc:postgresql:test"/>
- * <li>&lt;param name="{@link #setUser(String) user}" value="sa"/>
- * <li>&lt;param name="{@link #setPassword(String) password}" value="sa"/>
- * <li>&lt;param name="{@link #setDatabaseType(String) databaseType}" value="postgresql"/>
- * <li>&lt;param name="{@link #setDriver(String) driver}" value="org.postgresql.Driver"/>
- * <li>&lt;param name="{@link #setMinRecordLength(int) minRecordLength}" value="1024"/>
- * <li>&lt;param name="{@link #setMaxConnections(int) maxConnections}" value="2"/>
- * <li>&lt;param name="{@link #setCopyWhenReading(int) copyWhenReading}" value="true"/>
- * </ul>
- * 
+ * Configuration:
+ * <pre>
+ * &lt;DataStore class="org.apache.jackrabbit.core.data.db.DbDataStore">
+ *     &lt;param name="{@link #setUrl(String) url}" value="jdbc:postgresql:test"/>
+ *     &lt;param name="{@link #setUser(String) user}" value="sa"/>
+ *     &lt;param name="{@link #setPassword(String) password}" value="sa"/>
+ *     &lt;param name="{@link #setDatabaseType(String) databaseType}" value="postgresql"/>
+ *     &lt;param name="{@link #setDriver(String) driver}" value="org.postgresql.Driver"/>
+ *     &lt;param name="{@link #setMinRecordLength(int) minRecordLength}" value="1024"/>
+ *     &lt;param name="{@link #setMaxConnections(int) maxConnections}" value="2"/>
+ *     &lt;param name="{@link #setCopyWhenReading(int) copyWhenReading}" value="true"/>
+ * &lt/DataStore>
+ * </pre>
  * <p>
  * Only URL, user name and password usually need to be set. 
  * The remaining settings are generated using the database URL sub-protocol from the