From 7edd55554a03d7cdaefd12e4a319a0059414fb99 Mon Sep 17 00:00:00 2001 From: Stephen Colebourne Date: Sat, 26 Jul 2003 10:32:17 +0000 Subject: [PATCH] Fix Javadoc troubles from Phil Steitz git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137506 13f79535-47bb-0310-9956-ffa450edef68 --- .../commons/lang/RandomStringUtils.java | 19 ++++++++++--------- .../commons/lang/StringEscapeUtils.java | 4 ++-- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/src/java/org/apache/commons/lang/RandomStringUtils.java b/src/java/org/apache/commons/lang/RandomStringUtils.java index 01c2b2bd3..85a3c2fb0 100644 --- a/src/java/org/apache/commons/lang/RandomStringUtils.java +++ b/src/java/org/apache/commons/lang/RandomStringUtils.java @@ -64,7 +64,7 @@ * @author Gary Gregory * @author Phil Steitz * @since 1.0 - * @version $Id: RandomStringUtils.java,v 1.18 2003/07/26 00:26:32 ggregory Exp $ + * @version $Id: RandomStringUtils.java,v 1.19 2003/07/26 10:32:17 scolebourne Exp $ */ public class RandomStringUtils { @@ -200,7 +200,7 @@ public static String random(int count, int start, int end, boolean letters, bool *

This method has exactly the same semantics as * {@link #random(int,int,int,boolean,boolean,char[],Random)}, but * instead of using an externally supplied source of randomness, it uses - * the internal static {@link Random} instance ({@link #RANDOM}).

+ * the internal static {@link Random} instance.

* * @param count the length of random string to create * @param start the position in set of chars to start at @@ -221,19 +221,20 @@ public static String random(int count, int start, int end, boolean letters, bool *

Creates a random string based on a variety of options, using * supplied source of randomness.

* - *

If start and end are both 0, start and end are set + *

If start and end are both 0, start and end are set * to ' ' and 'z', the ASCII printable * characters, will be used, unless letters and numbers are both - * false, in which case, start and end are set to + * false, in which case, start and end are set to * 0 and Integer.MAX_VALUE. * - *

If set is not null, characters between start and + *

If set is not null, characters between start and * end are chosen.

* - *

As a source of randomness is used supplied {@link Random} - * instance. This makes method behave predictively, and allows - * usage of RandomStringUtils in situations that need - * repetitive behaviour.

+ *

This method accepts a user-supplied {@link Random} + * instance to use as a source of randomness. By seeding a single + * {@link Random} instance with a fixed seed and using it for each call, + * the same random sequence of strings can be generated repeatedly + * and predictably.

* * @param count the length of random string to create * @param start the position in set of chars to start at diff --git a/src/java/org/apache/commons/lang/StringEscapeUtils.java b/src/java/org/apache/commons/lang/StringEscapeUtils.java index 00b1199d7..202293811 100644 --- a/src/java/org/apache/commons/lang/StringEscapeUtils.java +++ b/src/java/org/apache/commons/lang/StringEscapeUtils.java @@ -71,8 +71,9 @@ * @author Helge Tesgaard * @author Sean Brown * @author Gary Gregory + * @author Phil Steitz * @since 2.0 - * @version $Id: StringEscapeUtils.java,v 1.19 2003/07/25 23:06:58 scolebourne Exp $ + * @version $Id: StringEscapeUtils.java,v 1.20 2003/07/26 10:32:17 scolebourne Exp $ */ public class StringEscapeUtils { @@ -446,7 +447,6 @@ public static void unescapeJavaScript(Writer out, String str) throws IOException * @param str the String to escape, may be null * @return a new escaped String, null if null string input * - * @see Entities * @see #unescapeHtml(String) * @see
ISO Entities * @see
HTML 3.2 Character Entities for ISO Latin-1