svn commit: r690351 - in /lucene/solr/trunk/src/java/org/apache/solr/core: CoreContainer.java SolrCore.java

[ho...@apache.org]

Author: hossman
Date: Fri Aug 29 11:04:45 2008
New Revision: 690351

URL: http://svn.apache.org/viewvc?rev=690351&view=rev
Log:
fix malformed javadoc, and add an @see for close() to getAdminCore since caller needs to be aware of it

Modified:
    lucene/solr/trunk/src/java/org/apache/solr/core/CoreContainer.java
    lucene/solr/trunk/src/java/org/apache/solr/core/SolrCore.java

Modified: lucene/solr/trunk/src/java/org/apache/solr/core/CoreContainer.java
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/src/java/org/apache/solr/core/CoreContainer.java?rev=690351&r1=690350&r2=690351&view=diff
==============================================================================
--- lucene/solr/trunk/src/java/org/apache/solr/core/CoreContainer.java (original)
+++ lucene/solr/trunk/src/java/org/apache/solr/core/CoreContainer.java Fri Aug 29 11:04:45 2008
@@ -457,6 +457,7 @@
   /**
    * Ensures there is a valid core to handle MultiCore admin taks and
    * increase its refcount.
+   * @see SolrCore#close() 
    * @return the acquired admin core, null if no core is available
    */               
   public SolrCore getAdminCore() {

Modified: lucene/solr/trunk/src/java/org/apache/solr/core/SolrCore.java
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/src/java/org/apache/solr/core/SolrCore.java?rev=690351&r1=690350&r2=690351&view=diff
==============================================================================
--- lucene/solr/trunk/src/java/org/apache/solr/core/SolrCore.java (original)
+++ lucene/solr/trunk/src/java/org/apache/solr/core/SolrCore.java Fri Aug 29 11:04:45 2008
@@ -586,20 +586,24 @@
   }
   
   /**
-   * Close all resources allocated by the core.
-   *  1. searcher
-   *  2. updateHandler
-   *  3. all CloseHooks will be notified
-   *  4. All MBeans will be unregistered from MBeanServer if JMX was enabled
+   * Close all resources allocated by the core...
+   * <ul>
+   *   <li>searcher</li>
+   *   <li>updateHandler</li>
+   *   <li>all CloseHooks will be notified</li>
+   *   <li>All MBeans will be unregistered from MBeanServer if JMX was enabled
+   *       </li>
+   * </ul>
    * <p>
-   * This should always be called when the core is obtained through:
-   * @see CoreContainer.getCore
-   * @see CoreContainer.getAdminCore
+   * This should always be called when the core is obtained through {@link CoreContainer#getCore} or {@link CoreContainer#getAdminCore}
    * </p>
+   * <p>
    * The actual close is performed if the core usage count is 1.
    * (A core is created with a usage count of 1).
    * If usage count is > 1, the usage count is decreased by 1.
-   * If usage count is &lt; 0, this is an error and a runtime exception is thrown.
+   * If usage count is &lt; 0, this is an error and a runtime exception 
+   * is thrown.
+   * </p>
    */
   public void close() {
     int count = refCount.decrementAndGet();