You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2019/03/10 15:52:29 UTC

[juneau] 04/09: Minor javadoc fixes.

This is an automated email from the ASF dual-hosted git repository.

jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git

commit 0ba1bd5f68efad06a3e1d6e0ebeba60863ba544e
Author: JamesBognar <ja...@apache.org>
AuthorDate: Sun Jan 13 16:08:50 2019 -0500

    Minor javadoc fixes.
---
 .../docs/Topics/06.juneau-config/01.Overview.html   |   2 +-
 .../12.ConfigStores/01.ConfigMemoryStore.html       |   2 +-
 .../12.ConfigStores/03.CustomConfigStores.html      |   6 +++---
 .../06.juneau-config/15.SystemDefaultConfig.html    |   2 +-
 .../03.Instantiation/03.BasicRest.html              |   2 +-
 juneau-doc/juneau-doc.jar                           | Bin 25553 -> 25564 bytes
 .../org/apache/juneau/doc/internal/SourceTag.java   |   2 +-
 juneau-doc/src/main/javadoc/overview.html           |  14 +++++++-------
 .../org/apache/juneau/rest/BasicRestJenaGroup.java  |   2 ++
 .../apache/juneau/rest/BasicRestServletGroup.java   |   2 +-
 pom.xml                                             |   6 +++---
 11 files changed, 21 insertions(+), 19 deletions(-)

diff --git a/juneau-doc/docs/Topics/06.juneau-config/01.Overview.html b/juneau-doc/docs/Topics/06.juneau-config/01.Overview.html
index b45cef7..11c1689 100644
--- a/juneau-doc/docs/Topics/06.juneau-config/01.Overview.html
+++ b/juneau-doc/docs/Topics/06.juneau-config/01.Overview.html
@@ -36,7 +36,7 @@ Overview
 	<ck>key4</ck> = <cv>http://bar</cv>
 </p>
 <p>
-	Config files are access through the {@link oaj.config.Config} class which
+	Config files are accessed through the {@link oaj.config.Config} class which
 	are created through the {@link oaj.config.ConfigBuilder} class.
 	Builder creator methods are provided on the <code>Config</code> class:
 </p>
diff --git a/juneau-doc/docs/Topics/06.juneau-config/12.ConfigStores/01.ConfigMemoryStore.html b/juneau-doc/docs/Topics/06.juneau-config/12.ConfigStores/01.ConfigMemoryStore.html
index 0c643f7..bb5bb63 100644
--- a/juneau-doc/docs/Topics/06.juneau-config/12.ConfigStores/01.ConfigMemoryStore.html
+++ b/juneau-doc/docs/Topics/06.juneau-config/12.ConfigStores/01.ConfigMemoryStore.html
@@ -39,7 +39,7 @@ ConfigMemoryStore
 		<jk>public synchronized</jk> String write(String name, String expectedContents, String newContents) {
 	
 			<jc>// This is a no-op.</jc>
-			<jk>if</jk> (isEquals(expectedContents, newContents))
+			<jk>if</jk> (<jsm>isEquals</jsm>(expectedContents, newContents))
 				<jk>return null</jk>;
 			
 			String currentContents = read(name);
diff --git a/juneau-doc/docs/Topics/06.juneau-config/12.ConfigStores/03.CustomConfigStores.html b/juneau-doc/docs/Topics/06.juneau-config/12.ConfigStores/03.CustomConfigStores.html
index 358e3ec..18c1c94 100644
--- a/juneau-doc/docs/Topics/06.juneau-config/12.ConfigStores/03.CustomConfigStores.html
+++ b/juneau-doc/docs/Topics/06.juneau-config/12.ConfigStores/03.CustomConfigStores.html
@@ -50,7 +50,7 @@ Custom ConfigStores
 			<jk>this</jk>.<jf>nameColumn</jf> = getStringProperty(<jsf>CONFIGSQLSTORE_nameColumn</jsf>);
 			<jk>this</jk>.<jf>valueColumn</jf> = getStringProperty(<jsf>CONFIGSQLSTORE_valueColumn</jsf>);		
 
-			<jk>int</jk> pollInterval = getStringProperty(<jsf>CONFIGSQLSTORE_pollInterval</jsf>, 600);
+			<jk>int</jk> pollInterval = getStringProperty(<jsf>CONFIGSQLSTORE_pollInterval</jsf>, 600);  <jc>// Time in seconds.</jc>
 			
 			TimerTask timerTask = <jk>new</jk> TimerTask() {
 				<ja>@Override</ja>
@@ -60,7 +60,7 @@ Custom ConfigStores
 			};
 
 			<jk>this</jk>.<jf>watcher</jf> = <jk>new</jk> Timer(<js>"MyTimer"</js>);
-			<jf>watcher</jf>.scheduleAtFixedRate(timerTask, 0, pollInterval * 10000);
+			<jf>watcher</jf>.scheduleAtFixedRate(timerTask, 0, pollInterval * 1000);
 		}
 		
 		<jk>private synchronized void</jk> poll() {
@@ -97,7 +97,7 @@ Custom ConfigStores
 		<jk>public synchronized</jk> String write(String name, String expectedContents, String newContents) {
 	
 			<jc>// This is a no-op.</jc>
-			<jk>if</jk> (isEquals(expectedContents, newContents))
+			<jk>if</jk> (<jsm>isEquals</jsm>(expectedContents, newContents))
 				<jk>return null</jk>;
 			
 			String currentContents = read(name);
diff --git a/juneau-doc/docs/Topics/06.juneau-config/15.SystemDefaultConfig.html b/juneau-doc/docs/Topics/06.juneau-config/15.SystemDefaultConfig.html
index dc7fb72..b154dbc 100644
--- a/juneau-doc/docs/Topics/06.juneau-config/15.SystemDefaultConfig.html
+++ b/juneau-doc/docs/Topics/06.juneau-config/15.SystemDefaultConfig.html
@@ -41,7 +41,7 @@ System Default Config
 			<li>Any file that end with <code>.cfg</code>.  First one matched alphabetically is used.
 		</ol>
 	<li>
-		In the context classpath (i.e. inside the jar itself):
+		In the context classpath root package (i.e. inside the jar itself):
 		<ol>
 			<li><code>&lt;jar-name&gt;.cfg</code>
 			<li><code>juneau.cfg</code>
diff --git a/juneau-doc/docs/Topics/07.juneau-rest-server/03.Instantiation/03.BasicRest.html b/juneau-doc/docs/Topics/07.juneau-rest-server/03.Instantiation/03.BasicRest.html
index 1c70f3d..4a2d788 100644
--- a/juneau-doc/docs/Topics/07.juneau-rest-server/03.Instantiation/03.BasicRest.html
+++ b/juneau-doc/docs/Topics/07.juneau-rest-server/03.Instantiation/03.BasicRest.html
@@ -23,7 +23,7 @@
 	annotation. 
 </p>
 <p>
-	The code for this class is virtually identical to {@link oaj.BasicRestServlet} but lacks a parent class:
+	The code for this class is virtually identical to {@link oajr.BasicRestServlet} but lacks a parent class:
 </p>
 <p class='bpcode w800'>
 	<ja>@RestResource</ja>(
diff --git a/juneau-doc/juneau-doc.jar b/juneau-doc/juneau-doc.jar
index feb28d3..219a265 100644
Binary files a/juneau-doc/juneau-doc.jar and b/juneau-doc/juneau-doc.jar differ
diff --git a/juneau-doc/src/main/java/org/apache/juneau/doc/internal/SourceTag.java b/juneau-doc/src/main/java/org/apache/juneau/doc/internal/SourceTag.java
index b1d65d4..622c675 100644
--- a/juneau-doc/src/main/java/org/apache/juneau/doc/internal/SourceTag.java
+++ b/juneau-doc/src/main/java/org/apache/juneau/doc/internal/SourceTag.java
@@ -102,7 +102,7 @@ public class SourceTag implements Taglet {
 		String path = f.getAbsolutePath();
 		String href = GITHUB_LINK + path.substring(JUNEAU_ROOT.length());
 
-		return "<a class='doclink' href='" + href + "'>" + label + "</a>";
+		return "<a class='doclink' target='_blank' href='" + href + "'>" + label + "</a>";
 	}
 
 	@Override
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index 4b8105f..4b23dcd 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -11267,7 +11267,7 @@
 	<ck>key4</ck> = <cv>http://bar</cv>
 </p>
 <p>
-	Config files are access through the {@link org.apache.juneau.config.Config} class which
+	Config files are accessed through the {@link org.apache.juneau.config.Config} class which
 	are created through the {@link org.apache.juneau.config.ConfigBuilder} class.
 	Builder creator methods are provided on the <code>Config</code> class:
 </p>
@@ -12586,7 +12586,7 @@
 		<jk>public synchronized</jk> String write(String name, String expectedContents, String newContents) {
 	
 			<jc>// This is a no-op.</jc>
-			<jk>if</jk> (isEquals(expectedContents, newContents))
+			<jk>if</jk> (<jsm>isEquals</jsm>(expectedContents, newContents))
 				<jk>return null</jk>;
 			
 			String currentContents = read(name);
@@ -12679,7 +12679,7 @@
 			<jk>this</jk>.<jf>nameColumn</jf> = getStringProperty(<jsf>CONFIGSQLSTORE_nameColumn</jsf>);
 			<jk>this</jk>.<jf>valueColumn</jf> = getStringProperty(<jsf>CONFIGSQLSTORE_valueColumn</jsf>);		
 
-			<jk>int</jk> pollInterval = getStringProperty(<jsf>CONFIGSQLSTORE_pollInterval</jsf>, 600);
+			<jk>int</jk> pollInterval = getStringProperty(<jsf>CONFIGSQLSTORE_pollInterval</jsf>, 600);  <jc>// Time in seconds.</jc>
 			
 			TimerTask timerTask = <jk>new</jk> TimerTask() {
 				<ja>@Override</ja>
@@ -12689,7 +12689,7 @@
 			};
 
 			<jk>this</jk>.<jf>watcher</jf> = <jk>new</jk> Timer(<js>"MyTimer"</js>);
-			<jf>watcher</jf>.scheduleAtFixedRate(timerTask, 0, pollInterval * 10000);
+			<jf>watcher</jf>.scheduleAtFixedRate(timerTask, 0, pollInterval * 1000);
 		}
 		
 		<jk>private synchronized void</jk> poll() {
@@ -12726,7 +12726,7 @@
 		<jk>public synchronized</jk> String write(String name, String expectedContents, String newContents) {
 	
 			<jc>// This is a no-op.</jc>
-			<jk>if</jk> (isEquals(expectedContents, newContents))
+			<jk>if</jk> (<jsm>isEquals</jsm>(expectedContents, newContents))
 				<jk>return null</jk>;
 			
 			String currentContents = read(name);
@@ -12905,7 +12905,7 @@
 			<li>Any file that end with <code>.cfg</code>.  First one matched alphabetically is used.
 		</ol>
 	<li>
-		In the context classpath (i.e. inside the jar itself):
+		In the context classpath root package (i.e. inside the jar itself):
 		<ol>
 			<li><code>&lt;jar-name&gt;.cfg</code>
 			<li><code>juneau.cfg</code>
@@ -13489,7 +13489,7 @@
 	annotation. 
 </p>
 <p>
-	The code for this class is virtually identical to {@link org.apache.juneau.BasicRestServlet} but lacks a parent class:
+	The code for this class is virtually identical to {@link org.apache.juneau.rest.BasicRestServlet} but lacks a parent class:
 </p>
 <p class='bpcode w800'>
 	<ja>@RestResource</ja>(
diff --git a/juneau-rest/juneau-rest-server-rdf/src/main/java/org/apache/juneau/rest/BasicRestJenaGroup.java b/juneau-rest/juneau-rest-server-rdf/src/main/java/org/apache/juneau/rest/BasicRestJenaGroup.java
index 2776ff3..e0437de 100644
--- a/juneau-rest/juneau-rest-server-rdf/src/main/java/org/apache/juneau/rest/BasicRestJenaGroup.java
+++ b/juneau-rest/juneau-rest-server-rdf/src/main/java/org/apache/juneau/rest/BasicRestJenaGroup.java
@@ -12,6 +12,8 @@
 // ***************************************************************************************************************************
 package org.apache.juneau.rest;
 
+import javax.servlet.http.HttpServlet;
+
 import org.apache.juneau.jena.*;
 import org.apache.juneau.rest.annotation.*;
 
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicRestServletGroup.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicRestServletGroup.java
index ddd20d0..fd40b31 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicRestServletGroup.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicRestServletGroup.java
@@ -29,7 +29,7 @@ import org.apache.juneau.rest.helper.*;
  *
  * <h5 class='section'>See Also:</h5>
  * <ul>
- * 	<li class='link'>{@doc juneau-rest-server.Instantiation.RouterPages}
+ * 	<li class='link'>{@doc juneau-rest-server.Instantiation.BasicRestServletGroup}
  * </ul>
  */
 @RestResource
diff --git a/pom.xml b/pom.xml
index f1d619c..998ebac 100644
--- a/pom.xml
+++ b/pom.xml
@@ -43,9 +43,9 @@
 		<httpclient.version>4.5.6</httpclient.version>
 		<jetty.version>9.4.13.v20181111</jetty.version>
 		<juneau.compare.version>8.0.0</juneau.compare.version>
-		<javadoc.juneau.version>8.0.0</javadoc.juneau.version>
-		<juneauVersion>8.0.0</juneauVersion>
-		<juneauVersionNext>8.0.1</juneauVersionNext>
+		<javadoc.juneau.version>8.0.1</javadoc.juneau.version>
+		<juneauVersion>8.0.1</juneauVersion>
+		<juneauVersionNext>8.0.2</juneauVersionNext>
 		<derby.version>10.10.2.0</derby.version>
 		<hibernate.version>5.0.9.Final</hibernate.version>
 		<javax.inject.version>1</javax.inject.version>