Author: rwhitcomb
Date: Fri Apr 27 17:30:42 2018
New Revision: 1830377
URL: http://svn.apache.org/viewvc?rev=1830377&view=rev
Log:
Tweak some Javadoc (mostly cleanup of lists).
Modified:
pivot/trunk/core/src/org/apache/pivot/json/JSONSerializer.java
pivot/trunk/core/src/org/apache/pivot/util/StringUtils.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Dimensions.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Insets.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java
Modified: pivot/trunk/core/src/org/apache/pivot/json/JSONSerializer.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/json/JSONSerializer.java?rev=1830377&r1=1830376&r2=1830377&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/json/JSONSerializer.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/json/JSONSerializer.java Fri Apr 27
17:30:42 2018
@@ -810,10 +810,15 @@ public class JSONSerializer implements S
* Writes data to a JSON stream.
*
* @param object The object to serialize. Must be one of the following
- * types: <ul> <li>pivot.collections.Map</li>
- * <li>pivot.collections.List</li> <li>java.lang.String</li>
- * <li>java.lang.Number</li> <li>java.lang.Boolean</li>
- * <li><tt>null</tt></li> </ul>
+ * types:
+ * <ul>
+ * <li>pivot.collections.Map</li>
+ * <li>pivot.collections.List</li>
+ * <li>java.lang.String</li>
+ * <li>java.lang.Number</li>
+ * <li>java.lang.Boolean</li>
+ * <li><tt>null</tt></li>
+ * </ul>
* @param writer The writer to which data will be written.
* @throws IOException for any errors during the writing process.
* @throws SerializationException for any formatting errors in the data.
Modified: pivot/trunk/core/src/org/apache/pivot/util/StringUtils.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/StringUtils.java?rev=1830377&r1=1830376&r2=1830377&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/StringUtils.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/StringUtils.java Fri Apr 27
17:30:42 2018
@@ -130,12 +130,12 @@ public final class StringUtils {
* Extension of {@link Boolean#parseBoolean} that is both more exact
* and supports more features. Specifically it will recognize:
* <ul>
- * <li><tt>true</tt> or <tt>false</tt> in mixed case.
- * <li><tt>yes</tt> or <tt>no</tt> in mixed case.
- * <li><tt>on</tt> or <tt>off</tt> in mixed case.
- * <li><tt>T</tt> or <tt>F</tt> in mixed case.
- * <li><tt>Y</tt> or <tt>N</tt> in mixed case.
- * <li><tt>1</tt> or <tt>0</tt>.
+ * <li><tt>true</tt> or <tt>false</tt> in mixed case.</li>
+ * <li><tt>yes</tt> or <tt>no</tt> in mixed case.</li>
+ * <li><tt>on</tt> or <tt>off</tt> in mixed case.</li>
+ * <li><tt>T</tt> or <tt>F</tt> in mixed case.</li>
+ * <li><tt>Y</tt> or <tt>N</tt> in mixed case.</li>
+ * <li><tt>1</tt> or <tt>0</tt>.</li>
* </ul>
*
* @param input The string value to convert to a boolean.
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java?rev=1830377&r1=1830376&r2=1830377&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java Fri
Apr 27 17:30:42 2018
@@ -39,13 +39,17 @@ import org.apache.pivot.util.Utils;
public final class BrowserApplicationContext extends ApplicationContext {
/**
* Applet used to host applications in a web browser. <p> This applet
- * supports the following parameters: <ul>
+ * supports the following parameters:
+ * <ul>
* <li><tt>application_class_name</tt> - the class name of the application
- * to launch.</li> <li><tt>startup_properties</tt> - startup properties to
+ * to launch.</li>
+ * <li><tt>startup_properties</tt> - startup properties to
* be passed to the application. Properties use HTTP query string syntax;
- * e.g. "a=1&b=2".</li> <li><tt>system_properties</tt> - system
properties
+ * e.g. "a=1&b=2".</li>
+ * <li><tt>system_properties</tt> - system properties
* to set at startup. Properties use HTTP query string syntax; e.g.
- * "a=1&b=2" (trusted applets only).</li> </ul>
+ * "a=1&b=2" (trusted applets only).</li>
+ * </ul>
*/
public static final class HostApplet extends Applet {
private static final long serialVersionUID = -7710026348576806673L;
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Dimensions.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Dimensions.java?rev=1830377&r1=1830376&r2=1830377&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Dimensions.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Dimensions.java Fri Apr 27
17:30:42 2018
@@ -144,6 +144,9 @@ public final class Dimensions implements
* @return The parsed dimensions value if possible.
* @throws IllegalArgumentException if the input value is null, empty, or
cannot be parsed in
* one of these forms.
+ * @see #Dimensions(Dictionary)
+ * @see #Dimensions(Sequence)
+ * @see #Dimensions(int, int)
*/
public static Dimensions decode(String value) {
Utils.checkNullOrEmpty(value, "dimensions");
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java?rev=1830377&r1=1830376&r2=1830377&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java Fri Apr 27
17:30:42 2018
@@ -197,6 +197,7 @@ public final class GraphicsUtilities {
* contains illegal hexadecimal digits.
* @throws IllegalArgumentException if the value is not in one of the
* formats listed above.
+ * @see CSSColor
*/
public static Color decodeColor(final String value, String argument)
throws NumberFormatException {
Utils.checkNullOrEmpty(value, argument == null ? "color" : argument);
@@ -257,6 +258,7 @@ public final class GraphicsUtilities {
* @throws IllegalArgumentException if the value is not in one of the
* formats listed above.
* @see #decodeColor(String, String)
+ * @see CSSColor
*/
public static Color decodeColor(final String value) throws
NumberFormatException {
return decodeColor(value, null);
@@ -310,13 +312,15 @@ public final class GraphicsUtilities {
* Interpret a dictionary as a {@link Paint} value.
*
* @param dictionary A dictionary containing a key {@value #PAINT_TYPE_KEY}
- * and further elements according to its value: <ul> <li><b>solid_color</b>
- * - key {@value #COLOR_KEY} with value being any of the
+ * and further elements according to its value:
+ * <ul>
+ * <li><b>solid_color</b> - key {@value #COLOR_KEY} with value being any
of the
* {@linkplain GraphicsUtilities#decodeColor color values recognized by
- * Pivot}</li> <li><b>gradient</b> - keys {@value #START_X_KEY},
- * {@value #START_Y_KEY}, {@value #END_X_KEY}, {@value #END_Y_KEY} (values
- * are coordinates), {@value #START_COLOR_KEY}, {@value #END_COLOR_KEY}
- * (values are {@linkplain GraphicsUtilities#decodeColor colors})</li>
+ * Pivot}</li>
+ * <li><b>gradient</b> - keys {@value #START_X_KEY}, {@value #START_Y_KEY},
+ * {@value #END_X_KEY}, {@value #END_Y_KEY} (values are coordinates),
+ * {@value #START_COLOR_KEY}, {@value #END_COLOR_KEY} (values are
+ * {@linkplain GraphicsUtilities#decodeColor colors})</li>
* <li><b>linear_gradient</b> - keys {@value #START_X_KEY},
* {@value #START_Y_KEY}, {@value #END_X_KEY}, {@value #END_Y_KEY}
* (coordinates), {@value #STOPS_KEY} (a list of dictionaries with keys
@@ -324,7 +328,8 @@ public final class GraphicsUtilities {
* <li><b>radial_gradient</b> - keys {@value #CENTER_X_KEY},
* {@value #CENTER_Y_KEY} (coordinates), {@value #RADIUS_KEY} (a number),
* {@value #STOPS_KEY} (a list of dictionaries with keys
- * {@value #OFFSET_KEY} and {@value #COLOR_KEY})</li> </ul>
+ * {@value #OFFSET_KEY} and {@value #COLOR_KEY})</li>
+ * </ul>
* @return The fully decoded paint value.
* @throws IllegalArgumentException if there is no paint type key found.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Insets.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Insets.java?rev=1830377&r1=1830376&r2=1830377&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Insets.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Insets.java Fri Apr 27 17:30:42
2018
@@ -196,10 +196,10 @@ public final class Insets implements Ser
* Decode a possible Insets value. The value can be in one of the
* following forms:
* <ul>
- * <li><pre>{ "top": nnn, "left": nnn, "bottom": nnn, "right": nnn }</pre>
- * <li><pre>[ top, left, bottom, right ]</pre>
- * <li><pre>top[,;] left[,;] bottom[,;] right</pre>
- * <li>nnnn
+ * <li><pre>{ "top": nnn, "left": nnn, "bottom": nnn, "right": nnn
}</pre></li>
+ * <li><pre>[ top, left, bottom, right ]</pre></li>
+ * <li><pre>top[,;] left[,;] bottom[,;] right</pre></li>
+ * <li><em>nnnn</em></li>
* </ul>
*
* @param value The string value of the Insets to decode.
@@ -207,6 +207,7 @@ public final class Insets implements Ser
* @throws IllegalArgumentException if the input is not in one of these
* formats.
* @see #Insets(Dictionary)
+ * @see #Insets(Sequence)
* @see #Insets(int, int, int, int)
* @see #Insets(int)
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java?rev=1830377&r1=1830376&r2=1830377&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java Fri Apr 27 17:30:42 2018
@@ -384,6 +384,10 @@ public final class Span {
* if the string starts with <code>"{"</code> but it cannot be parsed as
* a JSON map, or if it starts with <code>"["</code> but cannot be parsed
* as a JSON list.
+ * @see #Span(Dictionary)
+ * @see #Span(Sequence)
+ * @see #Span(int, int)
+ * @see #Span(int)
*/
public static Span decode(String value) {
Utils.checkNullOrEmpty(value, "value");
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java?rev=1830377&r1=1830376&r2=1830377&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java Fri Apr 27 17:30:42 2018
@@ -265,12 +265,15 @@ public abstract class Theme {
/**
* Produce a font by describing it relative to the current theme's font.
*
- * @param dictionary A dictionary with any of the following keys: <ul> <li>
- * {@value #NAME_KEY} - the family name of the font</li> <li>
- * {@value #SIZE_KEY} - the font size as an integer, or a string "x%" for a
- * relative size</li> <li>{@value #BOLD_KEY} - true/false</li> <li>
- * {@value #ITALIC_KEY} - true/false</li> </ul> Omitted values are taken
- * from the theme's font.
+ * @param dictionary A dictionary with any of the following keys:
+ * <ul>
+ * <li>{@value #NAME_KEY} - the family name of the font</li>
+ * <li>{@value #SIZE_KEY} - the font size as an integer, or a string "x%"
for a
+ * relative size</li>
+ * <li>{@value #BOLD_KEY} - true/false</li>
+ * <li>{@value #ITALIC_KEY} - true/false</li>
+ * </ul>
+ * Omitted values are taken from the theme's font.
* @return The new font derived from the current font.
* @throws IllegalArgumentException if the supplied dictionary is
<tt>null</tt>.
*/
