You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by ts...@apache.org on 2018/08/03 16:46:47 UTC
[1/2] wicket git commit: Fix JavaDoc warnings in wicket-util
Repository: wicket
Updated Branches:
refs/heads/master 69f8f058d -> 2fc0fdce3
Fix JavaDoc warnings in wicket-util
Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/a1d52bab
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/a1d52bab
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/a1d52bab
Branch: refs/heads/master
Commit: a1d52babb8e1141a9dcf05914c5aa85ff88e0970
Parents: 5226b12
Author: Peter Major <pe...@forgerock.com>
Authored: Wed Aug 1 09:32:06 2018 +0100
Committer: Peter Major <pe...@forgerock.com>
Committed: Wed Aug 1 10:18:53 2018 +0100
----------------------------------------------------------------------
.../wicket/util/convert/MaskConverter.java | 2 +-
.../org/apache/wicket/util/crypt/Base64.java | 15 ++++----
.../apache/wicket/util/diff/myers/package.html | 17 +++++----
.../org/apache/wicket/util/diff/package.html | 38 +++++++++-----------
.../apache/wicket/util/encoding/UrlDecoder.java | 2 +-
.../apache/wicket/util/encoding/UrlEncoder.java | 2 +-
.../wicket/util/io/FullyBufferedReader.java | 2 +-
.../org/apache/wicket/util/lang/Objects.java | 2 +-
.../org/apache/wicket/util/string/Strings.java | 4 +--
9 files changed, 42 insertions(+), 42 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/wicket/blob/a1d52bab/wicket-util/src/main/java/org/apache/wicket/util/convert/MaskConverter.java
----------------------------------------------------------------------
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/convert/MaskConverter.java b/wicket-util/src/main/java/org/apache/wicket/util/convert/MaskConverter.java
index dcf29da..27717f8 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/convert/MaskConverter.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/convert/MaskConverter.java
@@ -27,7 +27,7 @@ import org.apache.wicket.util.lang.Args;
/**
* A converter that takes a mask into account. It is specifically meant for overrides on individual
* components, that provide their own converter by returning it from
- * {@link Component#getConverter(Class)}. It uses an instance of {@link MaskFormatter} to delegate
+ * {@code Component#getConverter(Class)}. It uses an instance of {@link MaskFormatter} to delegate
* the masking and unmasking to.
* <p>
* The following characters can be specified (adopted from the MaskFormatter documentation):
http://git-wip-us.apache.org/repos/asf/wicket/blob/a1d52bab/wicket-util/src/main/java/org/apache/wicket/util/crypt/Base64.java
----------------------------------------------------------------------
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/crypt/Base64.java b/wicket-util/src/main/java/org/apache/wicket/util/crypt/Base64.java
index a36bb4a..358db37 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/crypt/Base64.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/crypt/Base64.java
@@ -21,14 +21,15 @@ import java.math.BigInteger;
/**
* Provides Base64 encoding and decoding with URL and filename safe alphabet as defined by RFC 3548,
* section 4.
- * <p/>
- * This Base64 encoder is modified to meet URL requirements. The changes are: '+' => '*', '/' =>
+ * <p>
+ * This Base64 encoder is modified to meet URL requirements. The changes are: '+' => '*', '/' =>
* '-', and no padding.
- * <p/>
+ * </p>
+ * <p>
* This class is taken from the Apache commons-codec, and adjusted to fit the Wicket framework's
* needs, especially external dependencies have been removed.
* </p>
- * <p/>
+ * <p>
* This class implements section <cite>4. Base 64 Encoding with URL and Filename Safe
* Alphabet</cite> from RFC 3548 <cite>The Base16, Base32, and Base64 Data Encodings</cite> by Simon
* Josefsson.
@@ -252,7 +253,7 @@ public class Base64
*
* @param lineLength
* Each line of encoded data will be at most of the given length (rounded down to
- * nearest multiple of 4). If lineLength <= 0, then the output will not be divided
+ * nearest multiple of 4). If lineLength <= 0, then the output will not be divided
* into lines (chunks). Ignored when decoding.
* @since 1.4
*/
@@ -277,7 +278,7 @@ public class Base64
*
* @param lineLength
* Each line of encoded data will be at most of the given length (rounded down to
- * nearest multiple of 4). If lineLength <= 0, then the output will not be divided
+ * nearest multiple of 4). If lineLength <= 0, then the output will not be divided
* into lines (chunks). Ignored when decoding.
* @param lineSeparator
* Each line of encoded data will end with this sequence of bytes.
@@ -306,7 +307,7 @@ public class Base64
*
* @param lineLength
* Each line of encoded data will be at most of the given length (rounded down to
- * nearest multiple of 4). If lineLength <= 0, then the output will not be divided
+ * nearest multiple of 4). If lineLength <= 0, then the output will not be divided
* into lines (chunks). Ignored when decoding.
* @param lineSeparator
* Each line of encoded data will end with this sequence of bytes.
http://git-wip-us.apache.org/repos/asf/wicket/blob/a1d52bab/wicket-util/src/main/java/org/apache/wicket/util/diff/myers/package.html
----------------------------------------------------------------------
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/diff/myers/package.html b/wicket-util/src/main/java/org/apache/wicket/util/diff/myers/package.html
index 2822bf0..ae5e9e9 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/diff/myers/package.html
+++ b/wicket-util/src/main/java/org/apache/wicket/util/diff/myers/package.html
@@ -62,19 +62,24 @@
</head>
<body>
<p>
- The {@link org.apache.maven.jrcs.diff.myers diff.myers} package
- implements <a href=
+ The {@link org.apache.wicket.util.diff.myers diff.myers} package
+ implements <a href=
"http://www.cs.arizona.edu/people/gene/">Gene Myers</a>'
differencing algorithm.
</p>
<p>
- Myer's algorithm produces optimum results (minimum diffs), but
+ Myers' algorithm produces optimum results (minimum diffs), but
consumes considerably more memory than SimpleDiff, so its not
suitable for very large files.
- </p>
+ </p>
+
+ Modifications:
+
+ 1 Aug 2018 aldaris
+
+ Fixed typos, and updated package references.
@author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
@version $Id: package.html,v 1.1 2006/03/12 00:24:21 juanca Exp $
-@see Diff
-@see org.apache.maven.jrcs.rcs.Archive
+@see org.apache.wicket.util.diff.Diff
</body>
</html>
http://git-wip-us.apache.org/repos/asf/wicket/blob/a1d52bab/wicket-util/src/main/java/org/apache/wicket/util/diff/package.html
----------------------------------------------------------------------
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/diff/package.html b/wicket-util/src/main/java/org/apache/wicket/util/diff/package.html
index 756b6f9..303b3ff 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/diff/package.html
+++ b/wicket-util/src/main/java/org/apache/wicket/util/diff/package.html
@@ -62,45 +62,39 @@
</head>
<body>
<p>
- The {@link org.apache.maven.jrcs.diff diff} package implements
+ The {@link org.apache.wicket.util.diff diff} package implements
the differencing engine that JRCS uses. The engine has the power
of Unix diff, is simple to understand, and can be used
independently of the archive handling functionality. The entry
point to the differencing engine is class {@link
- org.apache.maven.jrcs.diff.Diff Diff}.
+ org.apache.wicket.util.diff.Diff Diff}.
</p>
<p>
Text is represented as <code>Object[]</code> because the diff
- engine is capable of handling more than plain ascci. In fact,
+ engine is capable of handling more than plain ASCII. In fact,
arrays of any type that implements {@link
java.lang.Object#hashCode hashCode()} and {@link
java.lang.Object#equals equals()} correctly can be subject to
differencing using this library.
</p>
<p>
- Two implementations of the differencing algorithm are provided.
+ The {@link org.apache.wicket.util.diff.myers.MyersDiff MyersDiff}
+ is an implementation of <a href=
+ "http://www.cs.arizona.edu/people/gene/">Gene Myers</a>
+ differencing algorithm. Myers' algorithm produces optimum
+ results (minimum diffs), but consumes considerable amount of
+ memory, it may not be suitable for very large files.
</p>
- <ul>
- <li>
- {@link SimpleDiff Simple Diff} is a verys imple algorithm that
- is fast and works well with very large input sequences, but
- that frequently produces result that are subotimal (at times
- four or more times larger than GNU diff).
- </li>
- <li>
- {@link org.apache.commons.jrcs.diff.myers.MyersDiff MyersDiff}
- is an implementation of <a href=
- "http://www.cs.arizona.edu/people/gene/">Gene Myers</a>
- differencing algorithm. Myer's algorithm produces optimum
- results (minimum diffs), but consumes considerably more memory
- than SimpleDiff, so its not suitable for very large files.
- </li>
- </ul>
+
+ Modifications:
+
+ 1 Aug 2018 aldaris
+
+ Fixed typos, and updated package references.
<pre>
@author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
@version $Id: package.html,v 1.1 2006/03/12 00:24:21 juanca Exp $
-@see Diff
-@see org.apache.maven.jrcs.rcs.Archive
+@see Diff
</pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/wicket/blob/a1d52bab/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlDecoder.java
----------------------------------------------------------------------
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlDecoder.java b/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlDecoder.java
index 2e2f969..0f23cdf 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlDecoder.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlDecoder.java
@@ -44,7 +44,7 @@ public class UrlDecoder
* Encoder used to decode name or value components of a query string.<br/>
* <br/>
*
- * For example: http://org.acme/notthis/northis/oreventhis?buthis=isokay&asis=thispart
+ * For example: http://org.acme/notthis/northis/oreventhis?buthis=isokay&asis=thispart
*/
public static final UrlDecoder QUERY_INSTANCE = new UrlDecoder(true);
http://git-wip-us.apache.org/repos/asf/wicket/blob/a1d52bab/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlEncoder.java
----------------------------------------------------------------------
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlEncoder.java b/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlEncoder.java
index 85b18bd..4a24f3f 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlEncoder.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/encoding/UrlEncoder.java
@@ -60,7 +60,7 @@ public class UrlEncoder
* Encoder used to encode name or value components of a query string.<br/>
* <br/>
*
- * For example: http://org.acme/notthis/northis/oreventhis?buthis=isokay&asis=thispart
+ * For example: http://org.acme/notthis/northis/oreventhis?buthis=isokay&asis=thispart
*/
public static final UrlEncoder QUERY_INSTANCE = new UrlEncoder(Type.QUERY);
http://git-wip-us.apache.org/repos/asf/wicket/blob/a1d52bab/wicket-util/src/main/java/org/apache/wicket/util/io/FullyBufferedReader.java
----------------------------------------------------------------------
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/io/FullyBufferedReader.java b/wicket-util/src/main/java/org/apache/wicket/util/io/FullyBufferedReader.java
index 9317427..bec8497 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/io/FullyBufferedReader.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/io/FullyBufferedReader.java
@@ -77,7 +77,7 @@ public final class FullyBufferedReader
/**
* Get the characters from the position marker to toPos.
* <p>
- * If toPos < 0, than get all data from the position marker until the end. If toPos less than
+ * If toPos < 0, than get all data from the position marker until the end. If toPos less than
* the current position marker than return an empty string ""
*
* @param toPos
http://git-wip-us.apache.org/repos/asf/wicket/blob/a1d52bab/wicket-util/src/main/java/org/apache/wicket/util/lang/Objects.java
----------------------------------------------------------------------
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/lang/Objects.java b/wicket-util/src/main/java/org/apache/wicket/util/lang/Objects.java
index 38d3e77..3944d48 100755
--- a/wicket-util/src/main/java/org/apache/wicket/util/lang/Objects.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/lang/Objects.java
@@ -214,7 +214,7 @@ public final class Objects
* second value to compare
*
* @return integer describing the comparison between the two objects. A negative number
- * indicates that v1 < v2. Positive indicates that v1 > v2. Zero indicates v1 == v2.
+ * indicates that v1 < v2. Positive indicates that v1 > v2. Zero indicates v1 == v2.
*
* @throws IllegalArgumentException
* if the objects are both non-numeric yet of incompatible types or do not implement
http://git-wip-us.apache.org/repos/asf/wicket/blob/a1d52bab/wicket-util/src/main/java/org/apache/wicket/util/string/Strings.java
----------------------------------------------------------------------
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/string/Strings.java b/wicket-util/src/main/java/org/apache/wicket/util/string/Strings.java
index 9d6537b..8b80dbb 100755
--- a/wicket-util/src/main/java/org/apache/wicket/util/string/Strings.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/string/Strings.java
@@ -318,7 +318,7 @@ public final class Strings
* @param escapeSpaces
* True to replace ' ' with nonbreaking space
* @param convertToHtmlUnicodeEscapes
- * True to convert non-7 bit characters to unicode HTML (&#...)
+ * True to convert non-7 bit characters to unicode HTML (&#...)
* @return The escaped string
*/
public static CharSequence escapeMarkup(final CharSequence s, final boolean escapeSpaces,
@@ -827,7 +827,7 @@ public final class Strings
}
/**
- * Replace HTML numbers like 值 by the appropriate character.
+ * Replace HTML numbers like &#20540; by the appropriate character.
*
* @param str
* The text to be evaluated
[2/2] wicket git commit: Merge remote-tracking branch
'tmp/javadoc-fixes-util' into HEAD
Posted by ts...@apache.org.
Merge remote-tracking branch 'tmp/javadoc-fixes-util' into HEAD
Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/2fc0fdce
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/2fc0fdce
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/2fc0fdce
Branch: refs/heads/master
Commit: 2fc0fdce3176e9b0ad9a4be6fd339259ca00a17c
Parents: 69f8f05 a1d52ba
Author: Tobias Soloschenko <ts...@apache.org>
Authored: Fri Aug 3 18:45:10 2018 +0200
Committer: Tobias Soloschenko <ts...@apache.org>
Committed: Fri Aug 3 18:45:10 2018 +0200
----------------------------------------------------------------------
.../wicket/util/convert/MaskConverter.java | 2 +-
.../org/apache/wicket/util/crypt/Base64.java | 15 ++++----
.../apache/wicket/util/diff/myers/package.html | 17 +++++----
.../org/apache/wicket/util/diff/package.html | 38 +++++++++-----------
.../apache/wicket/util/encoding/UrlDecoder.java | 2 +-
.../apache/wicket/util/encoding/UrlEncoder.java | 2 +-
.../wicket/util/io/FullyBufferedReader.java | 2 +-
.../org/apache/wicket/util/lang/Objects.java | 2 +-
.../org/apache/wicket/util/string/Strings.java | 4 +--
9 files changed, 42 insertions(+), 42 deletions(-)
----------------------------------------------------------------------