Author: sseifert
Date: Fri Nov 6 20:52:46 2015
New Revision: 1713026
URL: http://svn.apache.org/viewvc?rev=1713026&view=rev
Log:
fix javadoc errors
Modified:
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONArray.java
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONObject.java
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/http/HTTP.java
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/io/JSONRenderer.java
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/jcr/JsonItemWriter.java
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/JsonObjectCreator.java
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XML.java
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XMLTokener.java
sling/trunk/bundles/commons/testing/src/main/java/org/apache/sling/commons/testing/integration/HttpTestBase.java
sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployFileMojo.java
sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployMojo.java
Modified:
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONArray.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONArray.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONArray.java
(original)
+++
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONArray.java
Fri Nov 6 20:52:46 2015
@@ -804,7 +804,7 @@ public class JSONArray {
/**
* Write the contents of the JSONObject as JSON text to a writer
- * using {@link JSONRenderer#write(JSONArray)}
+ * using {@link JSONRenderer#write(Writer, JSONArray)}
*/
public Writer write(Writer writer) throws JSONException {
return renderer.write(writer, this);
Modified:
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONObject.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONObject.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONObject.java
(original)
+++
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/JSONObject.java
Fri Nov 6 20:52:46 2015
@@ -74,7 +74,7 @@ import org.apache.sling.commons.json.io.
* <code>{ } [ ] / \ : , = ; #</code> and if they do not look like numbers
* and if they are not the reserved words <code>true</code>,
* <code>false</code>, or <code>null</code>.</li>
- * <li>Keys can be followed by <code>=</code> or <code>=></code> as well as
+ * <li>Keys can be followed by <code>=</code> or <code>=></code> as well as
* by <code>:</code>.</li>
* <li>Values can be followed by <code>;</code> <small>(semicolon)</small> as
* well as by <code>,</code> <small>(comma)</small>.</li>
@@ -882,7 +882,7 @@ public class JSONObject {
/**
* Produce a string in double quotes with backslash sequences in all the
- * right places. A backslash will be inserted within </, allowing JSON
+ * right places. A backslash will be inserted within </, allowing JSON
* text to be delivered in HTML. In JSON text, a string cannot contain a
* control character or an unescaped quote or backslash.
* @param string A String
@@ -997,7 +997,7 @@ public class JSONObject {
/**
* Write the contents of the JSONObject as JSON text to a writer
- * using {@link JSONRenderer#write(JSONObject)}
+ * using {@link JSONRenderer#write(Writer, JSONObject)}
*/
public Writer write(Writer writer) throws JSONException {
return renderer.write(writer, this);
Modified:
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/http/HTTP.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/http/HTTP.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/http/HTTP.java
(original)
+++
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/http/HTTP.java
Fri Nov 6 20:52:46 2015
@@ -56,12 +56,12 @@ public class HTTP {
* In addition, the other parameters in the header will be captured, using
* the HTTP field names as JSON names, so that <pre>
* Date: Sun, 26 May 2002 18:06:04 GMT
- * Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
+ * Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
* Cache-Control: no-cache</pre>
* become
* <pre>{...
* Date: "Sun, 26 May 2002 18:06:04 GMT",
- * Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
+ * Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
* "Cache-Control": "no-cache",
* ...}</pre>
* It does no further checking or conversion. It does not parse dates.
Modified:
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/io/JSONRenderer.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/io/JSONRenderer.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/io/JSONRenderer.java
(original)
+++
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/io/JSONRenderer.java
Fri Nov 6 20:52:46 2015
@@ -295,9 +295,6 @@ public class JSONRenderer {
* <p>
* Warning: This method assumes that the data structure is acyclical.
* @param value The value to be serialized.
- * @param indentFactor The number of spaces to add to each level of
- * indentation.
- * @param indent The indentation of the top level.
* @return a printable, displayable, transmittable
* representation of the object, beginning
* with <code>{</code> <small>(left brace)</small> and ending
@@ -374,9 +371,6 @@ public class JSONRenderer {
* Make a prettyprinted JSON text of this JSONObject.
* <p>
* Warning: This method assumes that the data structure is acyclical.
- * @param indentFactor The number of spaces to add to each level of
- * indentation.
- * @param indent The indentation of the top level.
* @return a printable, displayable, transmittable
* representation of the object, beginning
* with <code>{</code> <small>(left brace)</small> and ending
Modified:
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/jcr/JsonItemWriter.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/jcr/JsonItemWriter.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/jcr/JsonItemWriter.java
(original)
+++
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/jcr/JsonItemWriter.java
Fri Nov 6 20:52:46 2015
@@ -191,7 +191,7 @@ public class JsonItemWriter {
/**
* Writes the given value to the JSON writer. currently the following
- * conversions are done: <table>
+ * conversions are done: <table><caption></caption>
* <tr>
* <th>JSR Property Type</th>
* <th>JSON Value Type</th>
@@ -217,7 +217,7 @@ public class JsonItemWriter {
* <td>double</td>
* </tr>
* <tr>
- * <td><i>all other</li>
+ * <td><i>all other</i>
* </td>
* <td>string</td>
* </tr>
Modified:
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/JsonObjectCreator.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/JsonObjectCreator.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/JsonObjectCreator.java
(original)
+++
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/JsonObjectCreator.java
Fri Nov 6 20:52:46 2015
@@ -42,7 +42,6 @@ public abstract class JsonObjectCreator
/**
* Dump given resource in JSON, optionally recursing into its objects
- * @param tidy if <code>true</code> the json dump is nicely formatted
*/
public static JSONObject create(final Resource resource, final int
maxRecursionLevels)
throws JSONException {
Modified:
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XML.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XML.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XML.java
(original)
+++
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XML.java
Fri Nov 6 20:52:46 2015
@@ -39,7 +39,7 @@ import org.apache.sling.commons.json.JSO
*/
public class XML {
- /** The Character '&'. */
+ /** The Character '&'. */
public static final Character AMP = new Character('&');
/** The Character '''. */
@@ -51,10 +51,10 @@ public class XML {
/** The Character '='. */
public static final Character EQ = new Character('=');
- /** The Character '>'. */
+ /** The Character '>'. */
public static final Character GT = new Character('>');
- /** The Character '<'. */
+ /** The Character '<'. */
public static final Character LT = new Character('<');
/** The Character '?'. */
@@ -69,10 +69,10 @@ public class XML {
/**
* Replace special characters with XML escapes:
* <pre>
- * & <small>(ampersand)</small> is replaced by &amp;
- * < <small>(less than)</small> is replaced by &lt;
- * > <small>(greater than)</small> is replaced by &gt;
- * " <small>(double quote)</small> is replaced by &quot;
+ * & <i>(ampersand)</i> is replaced by &amp;
+ * < <i>(less than)</i> is replaced by &lt;
+ * > <i>(greater than)</i> is replaced by &gt;
+ * " <i>(double quote)</i> is replaced by &quot;
* </pre>
* @param string The string to be escaped.
* @return The escaped string.
@@ -271,7 +271,7 @@ public class XML {
* does not like to distinguish between elements and attributes.
* Sequences of similar elements are represented as JSONArrays. Content
* text may be placed in a "content" member. Comments, prologs, DTDs, and
- * <code><[ [ ]]></code> are ignored.
+ * <code><[ [ ]]></code> are ignored.
* @param string The source string.
* @return A JSONObject containing the structured data from the XML string.
* @throws JSONException
Modified:
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XMLTokener.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XMLTokener.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XMLTokener.java
(original)
+++
sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/xml/XMLTokener.java
Fri Nov 6 20:52:46 2015
@@ -85,10 +85,10 @@ public class XMLTokener extends JSONToke
/**
* Get the next XML outer token, trimming whitespace. There are two kinds
- * of tokens: the '<' character which begins a markup tag, and the content
+ * of tokens: the '<' character which begins a markup tag, and the
content
* text between markup tags.
*
- * @return A string, or a '<' Character, or null if there is no more
+ * @return A string, or a '<' Character, or null if there is no more
* source text.
* @throws JSONException
*/
@@ -122,7 +122,7 @@ public class XMLTokener extends JSONToke
/**
* Return the next entity. These entities are translated to Characters:
- * <code>& ' > < "</code>.
+ * <code>&amp; &apos; &gt; &lt; &quot;</code>.
* @param a An ampersand character.
* @return A Character or an entity String if the entity is not
recognized.
* @throws JSONException If missing ';' in XML entity.
@@ -146,9 +146,9 @@ public class XMLTokener extends JSONToke
/**
- * Returns the next XML meta token. This is used for skipping over <!...>
- * and <?...?> structures.
- * @return Syntax characters (<code>< > / = ! ?</code>) are returned as
+ * Returns the next XML meta token. This is used for skipping over
<!...>
+ * and <?...?> structures.
+ * @return Syntax characters (<code>< > / = ! ?</code>) are returned
as
* Character, and strings and names are returned as Boolean. We don't care
* what the values actually are.
* @throws JSONException If a string is not properly closed or if the XML
@@ -213,7 +213,7 @@ public class XMLTokener extends JSONToke
/**
* Get the next XML Token. These tokens are found inside of angle
- * brackets. It may be one of these characters: <code>/ > = ! ?</code> or
it
+ * brackets. It may be one of these characters: <code>/ > = ! ?</code>
or it
* may be a string wrapped in single quotes or double quotes, or it may be
a
* name.
* @return a String or a Character.
Modified:
sling/trunk/bundles/commons/testing/src/main/java/org/apache/sling/commons/testing/integration/HttpTestBase.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/commons/testing/src/main/java/org/apache/sling/commons/testing/integration/HttpTestBase.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/bundles/commons/testing/src/main/java/org/apache/sling/commons/testing/integration/HttpTestBase.java
(original)
+++
sling/trunk/bundles/commons/testing/src/main/java/org/apache/sling/commons/testing/integration/HttpTestBase.java
Fri Nov 6 20:52:46 2015
@@ -416,7 +416,7 @@ public class HttpTestBase extends TestCa
/** retrieve the contents of given URL and assert its content type
* @param expectedContentType use CONTENT_TYPE_DONTCARE if must not be
checked
- * @param httMethod supports just GET and POST methods
+ * @param httpMethod supports just GET and POST methods
* @throws IOException
* @throws HttpException */
public String getContent(String url, String expectedContentType,
List<NameValuePair> params, int expectedStatusCode, String httpMethod) throws
IOException {
Modified:
sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployFileMojo.java
URL:
http://svn.apache.org/viewvc/sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployFileMojo.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployFileMojo.java
(original)
+++
sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployFileMojo.java
Fri Nov 6 20:52:46 2015
@@ -27,7 +27,7 @@ import org.apache.maven.plugins.annotati
/**
* Deploy a JAR representing an OSGi Bundle. This method posts the bundle built
* by maven to an OSGi Bundle Repository accepting the bundle. The plugin uses
- * a </em>multipart/format-data</em> POST request to just post the file to
+ * a <em>multipart/format-data</em> POST request to just post the file to
* the URL configured in the <code>obr</code> property.
*/
@Mojo(name="deploy-file", requiresProject= false)
Modified:
sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployMojo.java
URL:
http://svn.apache.org/viewvc/sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployMojo.java?rev=1713026&r1=1713025&r2=1713026&view=diff
==============================================================================
---
sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployMojo.java
(original)
+++
sling/trunk/tooling/maven/maven-sling-plugin/src/main/java/org/apache/sling/maven/bundlesupport/BundleDeployMojo.java
Fri Nov 6 20:52:46 2015
@@ -30,7 +30,7 @@ import org.apache.maven.project.MavenPro
/**
* Deploy a JAR representing an OSGi Bundle. This method posts the bundle built
* by maven to an OSGi Bundle Repository accepting the bundle. The plugin uses
- * a </em>multipart/format-data</em> POST request to just post the file to
+ * a <em>multipart/format-data</em> POST request to just post the file to
* the URL configured in the <code>obr</code> property.
*/
@Mojo(name = "deploy", defaultPhase = LifecyclePhase.DEPLOY)
