Author: cziegeler
Date: Fri Jul 8 05:58:16 2016
New Revision: 1751861
URL: http://svn.apache.org/viewvc?rev=1751861&view=rev
Log:
Fix javadocs
Modified:
sling/trunk/bundles/engine/pom.xml
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/RequestUtil.java
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/ResponseUtil.java
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/SlingSettingsService.java
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/FilterProcessorMBean.java
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/RequestProcessorMBean.java
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/servlets/AbstractServiceReferenceConfig.java
Modified: sling/trunk/bundles/engine/pom.xml
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/engine/pom.xml?rev=1751861&r1=1751860&r2=1751861&view=diff
==============================================================================
--- sling/trunk/bundles/engine/pom.xml (original)
+++ sling/trunk/bundles/engine/pom.xml Fri Jul 8 05:58:16 2016
@@ -69,10 +69,6 @@
</instructions>
</configuration>
</plugin>
- </plugins>
- </build>
- <reporting>
- <plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
@@ -83,7 +79,7 @@
</configuration>
</plugin>
</plugins>
- </reporting>
+ </build>
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
Modified:
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/RequestUtil.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/RequestUtil.java?rev=1751861&r1=1751860&r2=1751861&view=diff
==============================================================================
---
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/RequestUtil.java
(original)
+++
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/RequestUtil.java
Fri Jul 8 05:58:16 2016
@@ -40,7 +40,7 @@ public class RequestUtil {
*
* "," and ";" are not allowed within name and value
*
- * @param value
+ * @param value The header value to parse
* @return A Map indexed by the Token names where the values are Map
* instances indexed by parameter name
*/
@@ -59,7 +59,7 @@ public class RequestUtil {
*
* "," and ";" are not allowed within name and value
*
- * @param value
+ * @param value The header value to parse
* @return A Map indexed by the Token names where the values are
* <code>Double</code> instances providing the value of the
* <code>q</code> parameter.
@@ -78,6 +78,9 @@ public class RequestUtil {
* <li>Otherwise check the servlet info
* <li>Otherwise use the fully qualified name of the servlet class
* </ol>
+ *
+ * @param servlet The servlet instance
+ * @return The name of the servlet
*/
public static String getServletName(final Servlet servlet) {
return
org.apache.sling.api.request.RequestUtil.getServletName(servlet);
Modified:
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/ResponseUtil.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/ResponseUtil.java?rev=1751861&r1=1751860&r2=1751861&view=diff
==============================================================================
---
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/ResponseUtil.java
(original)
+++
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/ResponseUtil.java
Fri Jul 8 05:58:16 2016
@@ -27,12 +27,19 @@ import java.io.Writer;
@Deprecated
public class ResponseUtil {
- /** Escape xml text */
+ /**
+ * Escape xml text
+ * @param input The text to escape
+ * @return The escaped text.
+ */
public static String escapeXml(final String input) {
return org.apache.sling.api.request.ResponseUtil.escapeXml(input);
}
- /** Return a Writer that writes escaped XML text to target
+ /**
+ * Return a Writer that writes escaped XML text to target
+ * @param target The writer to wrap
+ * @return The wrapped writer
*/
public static Writer getXmlEscapingWriter(final Writer target) {
return
org.apache.sling.api.request.ResponseUtil.getXmlEscapingWriter(target);
Modified:
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/SlingSettingsService.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/SlingSettingsService.java?rev=1751861&r1=1751860&r2=1751861&view=diff
==============================================================================
---
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/SlingSettingsService.java
(original)
+++
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/SlingSettingsService.java
Fri Jul 8 05:58:16 2016
@@ -30,6 +30,7 @@ public interface SlingSettingsService {
/**
* The identifier of the running Sling instance.
+ * @return The Sling identifier
*/
String getSlingId();
}
Modified:
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/FilterProcessorMBean.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/FilterProcessorMBean.java?rev=1751861&r1=1751860&r2=1751861&view=diff
==============================================================================
---
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/FilterProcessorMBean.java
(original)
+++
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/FilterProcessorMBean.java
Fri Jul 8 05:58:16 2016
@@ -28,6 +28,7 @@ public interface FilterProcessorMBean {
* Returns the number of invocations collected since last resetting the
* statistics.
*
+ * @return Get invocation count
* @see #resetStatistics()
*/
long getInvocationsCount();
@@ -36,6 +37,7 @@ public interface FilterProcessorMBean {
* Returns the mean filter invocation time in milliseconds since resetting
* the statistics.
*
+ * @return Get mean filter duration
* @see #resetStatistics()
*/
double getMeanFilterDurationMsec();
Modified:
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/RequestProcessorMBean.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/RequestProcessorMBean.java?rev=1751861&r1=1751860&r2=1751861&view=diff
==============================================================================
---
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/RequestProcessorMBean.java
(original)
+++
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/jmx/RequestProcessorMBean.java
Fri Jul 8 05:58:16 2016
@@ -28,6 +28,7 @@ public interface RequestProcessorMBean {
* Returns the number of requests collected since last resetting the
* statistics.
*
+ * @return Number of requests
* @see #resetStatistics()
*/
long getRequestsCount();
@@ -36,6 +37,7 @@ public interface RequestProcessorMBean {
* Returns the time in milliseconds used by the longest request since last
* resetting the statistics.
*
+ * @return Max request duration
* @see #resetStatistics()
*/
long getMaxRequestDurationMsec();
@@ -44,6 +46,7 @@ public interface RequestProcessorMBean {
* Returns the time in milliseconds used by the shortest request since last
* resetting the statistics.
*
+ * @return Min request duration
* @see #resetStatistics()
*/
long getMinRequestDurationMsec();
@@ -52,6 +55,7 @@ public interface RequestProcessorMBean {
* Returns the mean request processing time in milliseconds since resetting
* the statistics.
*
+ * @return Mean request duration
* @see #resetStatistics()
*/
double getMeanRequestDurationMsec();
@@ -61,6 +65,7 @@ public interface RequestProcessorMBean {
* statistics. If zero or one requests have been collected only, this
method
* returns zero.
*
+ * @return Standard deviation
* @see #resetStatistics()
*/
double getStandardDeviationDurationMsec();
@@ -69,6 +74,7 @@ public interface RequestProcessorMBean {
* Returns the maximum peak recursive execution depth since last
* resetting the statistics.
*
+ * @return Max peak recursion depth
* @see #resetStatistics()
*/
int getMaxPeakRecursionDepth();
@@ -78,6 +84,7 @@ public interface RequestProcessorMBean {
* Returns the minimal peak recursive execution depth since last
* resetting the statistics.
*
+ * @return Min peak recursion depth
* @see #resetStatistics()
*/
int getMinPeakRecursionDepth();
@@ -87,6 +94,7 @@ public interface RequestProcessorMBean {
* Returns the mean peak recursive execution depth since last
* resetting the statistics.
*
+ * @return Mean peak recursion depth
* @see #resetStatistics()
*/
double getMeanPeakRecursionDepth();
@@ -96,6 +104,7 @@ public interface RequestProcessorMBean {
* Returns the standard deviation of peak recursive execution depth since
last
* resetting the statistics.
*
+ * @return Standard deviation of peak recursion depth
* @see #resetStatistics()
*/
double getStandardDeviationPeakRecursionDepth();
@@ -104,6 +113,7 @@ public interface RequestProcessorMBean {
* Returns the maximum servlet call count since last
* resetting the statistics.
*
+ * @return Max servlet count call
* @see #resetStatistics()
*/
int getMaxServletCallCount();
@@ -113,6 +123,7 @@ public interface RequestProcessorMBean {
* Returns the minimum servlet call count since last
* resetting the statistics.
*
+ * @return Min servlet count call
* @see #resetStatistics()
*/
int getMinServletCallCount();
@@ -121,6 +132,7 @@ public interface RequestProcessorMBean {
* Returns the mean servlet call count since last
* resetting the statistics.
*
+ * @return Mean servlet count call
* @see #resetStatistics()
*/
double getMeanServletCallCount();
@@ -129,6 +141,7 @@ public interface RequestProcessorMBean {
* Returns the standard deviation servlet call counts since last
* resetting the statistics.
*
+ * @return Mean standard deviation for servlet count call
* @see #resetStatistics()
*/
double getStandardDeviationServletCallCount();
Modified:
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/servlets/AbstractServiceReferenceConfig.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/servlets/AbstractServiceReferenceConfig.java?rev=1751861&r1=1751860&r2=1751861&view=diff
==============================================================================
---
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/servlets/AbstractServiceReferenceConfig.java
(original)
+++
sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/servlets/AbstractServiceReferenceConfig.java
Fri Jul 8 05:58:16 2016
@@ -110,6 +110,7 @@ public abstract class AbstractServiceRef
* Returns the name of this configuration object. Implementations may use
* this value to implement the <code>ServletConfig.getServletName()</code>
* or <code>FilterConfig.getFilterName()</code> methods.
+ * @return The name
*/
protected String getName() {
return name;
@@ -119,6 +120,8 @@ public abstract class AbstractServiceRef
* Looks for a name value in the service reference properties. See the
* class comment at the top for the list of properties checked by this
* method.
+ * @param reference The service reference
+ * @return The name
*/
public static String getName(ServiceReference reference) {
String servletName = null;
