jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r1098960 - /jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/config/RepositoryConfig.java
Date Tue, 03 May 2011 08:22:04 GMT
Author: angela
Date: Tue May  3 08:22:04 2011
New Revision: 1098960

URL: http://svn.apache.org/viewvc?rev=1098960&view=rev
Log:
javadoc

Modified:
    jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/config/RepositoryConfig.java

Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/config/RepositoryConfig.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/config/RepositoryConfig.java?rev=1098960&r1=1098959&r2=1098960&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/config/RepositoryConfig.java
(original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/config/RepositoryConfig.java
Tue May  3 08:22:04 2011
@@ -99,10 +99,11 @@ public class RepositoryConfig
      * configuration file does not exist, then it is created using the
      * default Jackrabbit configuration settings.
      *
-     * @since Apache Jackrabbit 1.6
      * @param dir repository home directory
      * @return repository configuration
      * @throws ConfigurationException on configuration errors
+     * @throws java.io.IOException If an error occurs.
+     * @since Apache Jackrabbit 1.6
      */
     public static RepositoryConfig install(File dir)
             throws IOException, ConfigurationException {
@@ -118,10 +119,11 @@ public class RepositoryConfig
      * configuration file does not exist, then it is created using the
      * default Jackrabbit configuration settings.
      *
-     * @since Apache Jackrabbit 2.1
      * @param variables parser variables
      * @return repository configuration
      * @throws ConfigurationException on configuration errors
+     * @throws java.io.IOException If an error occurs.
+     * @since Apache Jackrabbit 2.1
      */
     public static RepositoryConfig install(Properties variables)
             throws IOException, ConfigurationException {
@@ -174,10 +176,12 @@ public class RepositoryConfig
      * configuration file does not exist, then it is created using the
      * default Jackrabbit configuration settings.
      *
-     * @since Apache Jackrabbit 1.6
+     * @param xml the configuration file.
      * @param dir repository home directory
      * @return repository configuration
      * @throws ConfigurationException on configuration errors
+     * @throws java.io.IOException If another error occurs.
+     * @since Apache Jackrabbit 1.6
      */
     public static RepositoryConfig install(File xml, File dir)
             throws IOException, ConfigurationException {
@@ -235,10 +239,11 @@ public class RepositoryConfig
      * An exception is thrown if the directory does not exist or if
      * the repository configuration file can not be read. 
      *
-     * @since Apache Jackrabbit 1.6
+     * @param xml The configuration file.
      * @param dir repository home directory
      * @return repository configuration
      * @throws ConfigurationException on configuration errors
+     * @since Apache Jackrabbit 1.6
      */
     public static RepositoryConfig create(File xml, File dir)
             throws ConfigurationException {
@@ -1038,6 +1043,9 @@ public class RepositoryConfig
     /**
      * Returns the cluster configuration. Returns <code>null</code> if clustering
      * has not been configured.
+     *
+     * @return the cluster configuration or <code>null</code> if clustering
+     * has not been configured.
      */
     public ClusterConfig getClusterConfig() {
         return cc;
@@ -1046,6 +1054,8 @@ public class RepositoryConfig
     /**
      * Returns the {@link ConnectionFactory} for this repository.
      * Please note that it must be closed explicitly.
+     *
+     * @return The connection factory configured for this repository.
      */
     public ConnectionFactory getConnectionFactory() {
         return cf;



Mime
View raw message