Author: akarasulu
Date: Tue Nov 20 11:43:23 2007
New Revision: 596799

URL: http://svn.apache.org/viewvc?rev=596799&view=rev
Log:
need to document default behavoir in configurations

Modified:
    directory/apacheds/branches/bigbang/core/src/main/java/org/apache/directory/server/core/DirectoryService.java

Modified: directory/apacheds/branches/bigbang/core/src/main/java/org/apache/directory/server/core/DirectoryService.java
URL: http://svn.apache.org/viewvc/directory/apacheds/branches/bigbang/core/src/main/java/org/apache/directory/server/core/DirectoryService.java?rev=596799&r1=596798&r2=596799&view=diff
==============================================================================
--- directory/apacheds/branches/bigbang/core/src/main/java/org/apache/directory/server/core/DirectoryService.java (original)
+++ directory/apacheds/branches/bigbang/core/src/main/java/org/apache/directory/server/core/DirectoryService.java Tue Nov 20 11:43:23 2007
@@ -270,9 +270,22 @@
     void setWorkingDirectory( File workingDirectory );
 
 
+    /**
+     * Sets the shutdown hook flag which controls whether or not this DirectoryService
+     * registers a JVM shutdown hook to flush caches and synchronize to disk safely.  This is
+     * enabled by default.
+     *
+     * @param shutdownHookEnabled true to enable the shutdown hook, false to disable
+     */
     void setShutdownHookEnabled( boolean shutdownHookEnabled );
 
 
+    /**
+     * Checks to see if this DirectoryService has registered a JVM shutdown hook
+     * to flush caches and synchronize to disk safely.  This is enabled by default.
+     *
+     * @return true if a shutdown hook is registered, false if it is not
+     */
     boolean isShutdownHookEnabled();