[dna-commits] DNA SVN: r1577 - trunk/dna-jcr/src/main/java/org/jboss/dna/jcr.

[dna-commits at lists.jboss.org]

Author: rhauch
Date: 2010-01-09 17:27:32 -0500 (Sat, 09 Jan 2010)
New Revision: 1577

Modified:
   trunk/dna-jcr/src/main/java/org/jboss/dna/jcr/JndiRepositoryFactory.java
Log:
Added missing JavaDoc @return parameter.

Modified: trunk/dna-jcr/src/main/java/org/jboss/dna/jcr/JndiRepositoryFactory.java
===================================================================
--- trunk/dna-jcr/src/main/java/org/jboss/dna/jcr/JndiRepositoryFactory.java	2010-01-09 22:09:07 UTC (rev 1576)
+++ trunk/dna-jcr/src/main/java/org/jboss/dna/jcr/JndiRepositoryFactory.java	2010-01-09 22:27:32 UTC (rev 1577)
@@ -30,11 +30,11 @@
  * <pre>
  *   &lt;GlobalNamingResources&gt;
  *         &lt;!-- Other configuration omitted --&gt;
- *      &lt;Resource name="jcr/local" auth="Container"
- *           type="javax.jcr.Repository"
- *           factory="org.jboss.dna.jcr.JndiRepositoryFactory"
- *           configFile="/tck/default/configRepository.xml"
- *           repositoryName="Test Repository Source"
+ *      &lt;Resource name=&quot;jcr/local&quot; auth=&quot;Container&quot;
+ *           type=&quot;javax.jcr.Repository&quot;
+ *           factory=&quot;org.jboss.dna.jcr.JndiRepositoryFactory&quot;
+ *           configFile=&quot;/tck/default/configRepository.xml&quot;
+ *           repositoryName=&quot;Test Repository Source&quot;
  *           /&gt;
  *   &lt;/GlobalNamingResources&gt;
  * </pre>
@@ -110,6 +110,7 @@
      * @param name ignored
      * @param nameCtx ignored
      * @param environment ignored
+     * @return the repository; never null
      * @throws IOException if there is an error or problem reading the configuration resource at the supplied path
      * @throws SAXException if the contents of the configuration resource are not valid XML
      * @throws NamingException if there is an error registering the namespace listener