Author: rwhitcomb
Date: Thu Dec 31 18:02:57 2020
New Revision: 1884991
URL: http://svn.apache.org/viewvc?rev=1884991&view=rev
Log:
Fix obsolete Javadoc constructs.
Added:
pivot/trunk/wtk/src/org/apache/pivot/wtk/util/package.html
Modified:
pivot/trunk/core/src/org/apache/pivot/beans/BXML.java
pivot/trunk/core/src/org/apache/pivot/beans/BXMLSerializer.java
pivot/trunk/core/src/org/apache/pivot/collections/Dictionary.java
pivot/trunk/core/src/org/apache/pivot/collections/List.java
pivot/trunk/core/src/org/apache/pivot/collections/ListListener.java
pivot/trunk/core/src/org/apache/pivot/collections/Queue.java
pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java
pivot/trunk/core/src/org/apache/pivot/collections/Stack.java
pivot/trunk/core/src/org/apache/pivot/collections/adapter/package.html
pivot/trunk/core/src/org/apache/pivot/serialization/CSVSerializer.java
pivot/trunk/core/src/org/apache/pivot/serialization/MacroReader.java
pivot/trunk/core/src/org/apache/pivot/text/CharSpan.java
pivot/trunk/core/src/org/apache/pivot/text/FileSizeFormat.java
pivot/trunk/core/src/org/apache/pivot/util/BooleanResult.java
pivot/trunk/core/src/org/apache/pivot/util/CalendarDate.java
pivot/trunk/core/src/org/apache/pivot/util/ClassUtils.java
pivot/trunk/core/src/org/apache/pivot/util/Constants.java
pivot/trunk/core/src/org/apache/pivot/util/EmptyIterator.java
pivot/trunk/core/src/org/apache/pivot/util/ImmutableIterator.java
pivot/trunk/core/src/org/apache/pivot/util/ListenerList.java
pivot/trunk/core/src/org/apache/pivot/util/StringUtils.java
pivot/trunk/core/src/org/apache/pivot/util/Time.java
pivot/trunk/core/src/org/apache/pivot/util/Utils.java
pivot/trunk/core/src/org/apache/pivot/util/Vote.java
pivot/trunk/core/src/org/apache/pivot/util/VoteResult.java
pivot/trunk/core/src/org/apache/pivot/xml/Element.java
pivot/trunk/demos/src/org/apache/pivot/demos/itunes/SearchDemo.java
pivot/trunk/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/BXMLExplorerDocument.java
pivot/trunk/web/src/org/apache/pivot/web/Query.java
pivot/trunk/web/src/org/apache/pivot/web/QueryException.java
pivot/trunk/web/src/org/apache/pivot/web/package.html
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraCalendarSkin.java
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraScrollBarSkin.java
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/package.html
pivot/trunk/wtk/src/org/apache/pivot/wtk/Bounds.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Calendar.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButton.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/CardPane.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooser.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Component.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Container.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/DesktopApplicationContext.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Editor.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/FillPane.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Gauge.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/GraphicsUtilities.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/GridPane.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Insets.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Limits.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ListButton.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ListView.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Point.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/RangeSelection.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ScriptApplication.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollPane.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Skin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Spinner.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SplitPane.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePane.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableView.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeader.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TaskAdapter.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPane.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/content/CalendarDateSpinnerData.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/content/ListViewIndexBindMapping.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/content/NumericSpinnerData.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/content/SpinnerIndexBindMapping.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/content/SpinnerItemRenderer.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/BlurDecorator.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Decorator.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ScaleDecorator.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/ShadeDecorator.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/Transition.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/WatermarkDecorator.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/media/BufferedImageSerializer.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/media/MovieListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/NumberRulerSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/RulerSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ScrollPaneSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextAreaSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinNodeView.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/text/PlainTextSerializer.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/util/ColorUtilities.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/IntRangeValidator.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/LongRangeValidator.java
Modified: pivot/trunk/core/src/org/apache/pivot/beans/BXML.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/beans/BXML.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/beans/BXML.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/beans/BXML.java Thu Dec 31 18:02:57
2020
@@ -32,7 +32,7 @@ import java.lang.annotation.Target;
public @interface BXML {
/**
* @return The ID of the BXML variable that references the element to
bind. It
- * should be a valid <tt>bxml:id</tt> from the loaded BXML resource. If
+ * should be a valid <code>bxml:id</code> from the loaded BXML resource. If
* unspecified, the name of the annotated field will be used.
*/
String id() default "\0";
Modified: pivot/trunk/core/src/org/apache/pivot/beans/BXMLSerializer.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/beans/BXMLSerializer.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/beans/BXMLSerializer.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/beans/BXMLSerializer.java Thu Dec 31
18:02:57 2020
@@ -1500,7 +1500,7 @@ public class BXMLSerializer implements S
/**
* Hook used for standardized reporting of exceptions during this process.
* <p>Subclasses should override this method in order to do something
besides
- * print to <tt>System.err</tt>.
+ * print to {@code System.err}.
* @param exception Whatever exception has been thrown during processing.
*/
protected void reportException(final Throwable exception) {
Modified: pivot/trunk/core/src/org/apache/pivot/collections/Dictionary.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/Dictionary.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/Dictionary.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/Dictionary.java Thu Dec
31 18:02:57 2020
@@ -86,9 +86,9 @@ public interface Dictionary<K, V> {
* Retrieves the value for the given key.
*
* @param key The key whose value is to be returned.
- * @return The value corresponding to <tt>key</tt>, or null if the key does
+ * @return The value corresponding to <code>key</code>, or null if the key
does
* not exist. Will also return null if the key refers to a null value. Use
- * <tt>containsKey()</tt> to distinguish between these two cases.
+ * {@link #containsKey} to distinguish between these two cases.
*/
V get(K key);
@@ -160,7 +160,7 @@ public interface Dictionary<K, V> {
* Retrieve a String value from this dictionary; returning null if the key
* does not exist.
*
- * @param key The key for the (supposed) <tt>String</tt> value.
+ * @param key The key for the (supposed) {@code String} value.
* @return The string value, or {@code null} if the key is not present.
*/
default String getString(K key) {
@@ -171,7 +171,7 @@ public interface Dictionary<K, V> {
* Retrieve a String value from this dictionary; returning null if the key
* does not exist.
*
- * @param key The key for the (supposed) <tt>String</tt> value.
+ * @param key The key for the (supposed) {@code String} value.
* @param defaultValue The string to return if the key is not present.
* @return The string value, or the default value if the key is not
present.
*/
@@ -186,7 +186,7 @@ public interface Dictionary<K, V> {
* Using the other methods in this interface, retrieve an integer value
* from this dictionary; returning 0 if the key does not exist.
*
- * @param key The key for the (supposed) <tt>Integer</tt>
+ * @param key The key for the (supposed) {@code Integer}
* value to retrieve (actually any {@link Number} will work).
* @return The integer value, or 0 if the key is not present.
*/
@@ -198,7 +198,7 @@ public interface Dictionary<K, V> {
* Using the other methods in this interface, retrieve an integer value
* from this dictionary; returning the given default if the key does not
exist.
*
- * @param key The key for the (supposed) <tt>Integer</tt>
+ * @param key The key for the (supposed) {@code Integer}
* value to retrieve (actually any {@link Number} will work).
* @param defaultValue The value to return if the key is not present.
* @return The integer value, or the default value if the key is not
present.
@@ -214,7 +214,7 @@ public interface Dictionary<K, V> {
* Using the other methods in this interface, retrieve a boolean value
* from this dictionary; returning false if the key does not exist.
*
- * @param key The key for the (supposed) <tt>Boolean</tt>
+ * @param key The key for the (supposed) {@code Boolean}
* value to retrieve.
* @return The boolean value, or false if the key is not present.
*/
@@ -226,7 +226,7 @@ public interface Dictionary<K, V> {
* Using the other methods in this interface, retrieve a boolean value
* from this dictionary; returning a default value if the key does not
exist.
*
- * @param key The key for the (supposed) <tt>Boolean</tt>
+ * @param key The key for the (supposed) {@code Boolean}
* value to retrieve.
* @param defaultValue What to return if the key is not present.
* @return The boolean value, or the default if the key is not present.
@@ -242,7 +242,7 @@ public interface Dictionary<K, V> {
* Using the other methods in this interface, retrieve a {@link Color}
value
* from this dictionary; returning {@code null} if the key does not exist.
*
- * @param key The key for the (supposed) <tt>Color</tt>
+ * @param key The key for the (supposed) {@code Color}
* value to retrieve.
* @return The color value, or {@code null} if the key is not present.
*/
@@ -254,7 +254,7 @@ public interface Dictionary<K, V> {
* Using the other methods in this interface, retrieve a {@link Font} value
* from this dictionary; returning {@code null} if the key does not exist.
*
- * @param key The key for the (supposed) <tt>Font</tt>
+ * @param key The key for the (supposed) {@code Font}
* value to retrieve.
* @return The font value, or {@code null} if the key is not present.
*/
Modified: pivot/trunk/core/src/org/apache/pivot/collections/List.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/List.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/List.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/List.java Thu Dec 31
18:02:57 2020
@@ -89,7 +89,7 @@ public interface List<T> extends Sequenc
*
* @param item The item to be added to the list.
* @param index The index at which the item should be inserted. Must be a
- * value between <tt>0</tt> and <tt>getLength()</tt>.
+ * value between <code>0</code> and {@code getLength()}.
* @throws IllegalArgumentException If the list is sorted and the insertion
* point of the item does not match the given index.
* @see ListListener#itemInserted(List, int)
Modified: pivot/trunk/core/src/org/apache/pivot/collections/ListListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/ListListener.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/ListListener.java
(original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/ListListener.java Thu Dec
31 18:02:57 2020
@@ -78,7 +78,7 @@ public interface ListListener<T> {
*
* @param list The source of the list event.
* @param index The index of the item that was updated.
- * @param previousItem The item that was previously stored at
<tt>index</tt>.
+ * @param previousItem The item that was previously stored at {@code
index}.
*/
default void itemUpdated(List<T> list, int index, T previousItem) {
}
Modified: pivot/trunk/core/src/org/apache/pivot/collections/Queue.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/Queue.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/Queue.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/Queue.java Thu Dec 31
18:02:57 2020
@@ -25,7 +25,7 @@ import org.apache.pivot.util.ListenerLis
public interface Queue<T> extends Collection<T> {
/**
* Enqueues an item. If the queue is unsorted, the item is added at the
tail
- * of the queue (index <tt>0</tt>). Otherwise, it is inserted at the
+ * of the queue (index <code>0</code>). Otherwise, it is inserted at the
* appropriate index.
* <p> If there is a maximum queue length defined and the queue is already
at
* the maximum length this new item will not be queued.
@@ -45,7 +45,7 @@ public interface Queue<T> extends Collec
/**
* Returns the item at the head of the queue without removing it from the
* queue. Returns null if the queue contains no items. Will also return
null
- * if the head item in the queue is null. <tt>isEmpty()</tt> can be used to
+ * if the head item in the queue is null. {@code isEmpty()} can be used to
* distinguish between these two cases.
* @return The object at the head of the queue (not removed from the
queue).
*/
Modified: pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java Thu Dec 31
18:02:57 2020
@@ -184,10 +184,10 @@ public interface Sequence<T> {
public interface ItemIterator<T> extends Iterator<T> {
/**
* Gets the path within the nested sequence to the item most
- * recently returned by a call to <tt>next()</tt>.
+ * recently returned by a call to {@code next()}.
*
* @return The path (from the root sequence) to the current item.
- * @throws IllegalStateException If <tt>next()</tt> has not yet
been
+ * @throws IllegalStateException If {@code next()} has not yet been
* called on this iterator.
*/
public Path getPath();
@@ -238,7 +238,7 @@ public interface Sequence<T> {
}
/**
- * Normalizes <tt>stack</tt> and <tt>nextPath</tt> such that the
+ * Normalizes {@code stack} and {@code nextPath} such that the
* iterator is pointing to a valid item or the end of the nested
* sequence.
*/
@@ -487,7 +487,7 @@ public interface Sequence<T> {
* Adds an item to the sequence.
*
* @param item The item to be added to the sequence.
- * @return The index at which the item was added, or <tt>-1</tt> if the
item
+ * @return The index at which the item was added, or <code>-1</code> if
the item
* was not added to the sequence.
*/
int add(T item);
@@ -497,7 +497,7 @@ public interface Sequence<T> {
*
* @param item The item to be added to the sequence.
* @param index The index at which the item should be inserted. Must be a
- * value between <tt>0</tt> and <tt>getLength()</tt>.
+ * value between <code>0</code> and {@code getLength()}.
*/
void insert(T item, int index);
@@ -515,7 +515,7 @@ public interface Sequence<T> {
* Removes the first occurrence of the given item from the sequence.
*
* @param item The item to remove.
- * @return The index of the item that was removed, or <tt>-1</tt> if the
item
+ * @return The index of the item that was removed, or <code>-1</code> if
the item
* could not be found.
* @see #remove(int, int)
*/
@@ -525,7 +525,7 @@ public interface Sequence<T> {
* Removes one or more items from the sequence.
*
* @param index The starting index to remove.
- * @param count The number of items to remove, beginning with
<tt>index</tt>.
+ * @param count The number of items to remove, beginning with {@code
index}.
* @return A sequence containing the items that were removed.
*/
Sequence<T> remove(int index, int count);
@@ -543,7 +543,7 @@ public interface Sequence<T> {
*
* @param item The item to locate.
* @return The index of first occurrence of the item if it exists in the
- * sequence; <tt>-1</tt>, otherwise.
+ * sequence; <code>-1</code>, otherwise.
*/
int indexOf(T item);
Modified: pivot/trunk/core/src/org/apache/pivot/collections/Stack.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/Stack.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/Stack.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/Stack.java Thu Dec 31
18:02:57 2020
@@ -25,7 +25,7 @@ import org.apache.pivot.util.ListenerLis
public interface Stack<T> extends Collection<T> {
/**
* "Pushes" an item onto the stack. If the stack is unsorted, the item is
- * added at the top of the stack (<tt>getLength()</tt>). Otherwise, it is
+ * added at the top of the stack ({@code getLength()}). Otherwise, it is
* inserted at the appropriate index.
* <p> If there is a maximum stack depth defined and the stack goes past
* this maximum depth, the deepest item (which could be this new item,
@@ -46,7 +46,7 @@ public interface Stack<T> extends Collec
/**
* Returns the item on top of the stack without removing it from the stack.
* Returns null if the stack contains no items. Will also return null if
the
- * top item in the stack is null. <tt>getLength()</tt> can be used to
+ * top item in the stack is null. {@code getLength()} can be used to
* distinguish between these two cases.
* @return The top item from the stack (which remains there).
*/
Modified: pivot/trunk/core/src/org/apache/pivot/collections/adapter/package.html
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/adapter/package.html?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/adapter/package.html
(original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/adapter/package.html Thu
Dec 31 18:02:57 2020
@@ -19,6 +19,6 @@ limitations under the License.
<head></head>
<body>
<p>Provides a set of collection implementations that are backed by
-<tt>java.util</tt> collections.</p>
+<code>java.util</code> collections.</p>
</body>
</html>
Modified: pivot/trunk/core/src/org/apache/pivot/serialization/CSVSerializer.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/serialization/CSVSerializer.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/serialization/CSVSerializer.java
(original)
+++ pivot/trunk/core/src/org/apache/pivot/serialization/CSVSerializer.java Thu
Dec 31 18:02:57 2020
@@ -204,7 +204,7 @@ public class CSVSerializer implements Se
*
* @param reader The reader from which data will be read.
* @return A list containing the data read from the CSV file. The list
items
- * are instances of <tt>Dictionary<String, Object></tt> populated by
mapping columns
+ * are instances of {@code Dictionary<String, Object>} populated by
mapping columns
* in the CSV file to keys in the key sequence. <p> If no keys have been
* specified when this method is called, they are assumed to be defined in
* the first line of the file.
@@ -428,7 +428,7 @@ public class CSVSerializer implements Se
* Writes values to a comma-separated value stream.
*
* @param items A list containing the data to write to the CSV file. List
- * items must be instances of <tt>Dictionary<String, Objecti></tt>.
The dictionary
+ * items must be instances of {@code Dictionary<String, Object>}. The
dictionary
* values will be written out in the order specified by the key sequence.
* @param writer The writer to which data will be written.
* @throws IOException for any errors during writing.
Modified: pivot/trunk/core/src/org/apache/pivot/serialization/MacroReader.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/serialization/MacroReader.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/serialization/MacroReader.java
(original)
+++ pivot/trunk/core/src/org/apache/pivot/serialization/MacroReader.java Thu
Dec 31 18:02:57 2020
@@ -26,7 +26,7 @@ import java.util.Queue;
/**
* This is a {@link Reader} that can be instantiated inline with any other
- * <tt>Reader</tt> to provide macro capabilities.
+ * {@code Reader} to provide macro capabilities.
* <p> We recognize <code>#define <i>NAME value</i></code> as definitions
* as well as <code>#undef <i>NAME</i></code> to remove a previous definition.
* <p> The macro name must correspond to the Unicode naming conventions (see
Modified: pivot/trunk/core/src/org/apache/pivot/text/CharSpan.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/text/CharSpan.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/text/CharSpan.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/text/CharSpan.java Thu Dec 31
18:02:57 2020
@@ -24,7 +24,7 @@ import org.apache.pivot.util.Utils;
/**
* Class representing a span of characters. The range includes all values
- * in the interval <i><tt>[start, start+length-1]</tt></i> inclusive. This is
the paradigm
+ * in the interval <i><code>[start, start+length-1]</code></i> inclusive.
This is the paradigm
* used in a lot of places (notably the text controls) to indicate a selection.
* <p> A zero-length span indicates a single caret position at the given start.
* <p> Negative lengths are not supported and will throw exceptions, as will
@@ -125,7 +125,7 @@ public final class CharSpan {
/**
* Returns the inclusive end value of this char span, which is the
- * <tt>start + length - 1</tt>. So, if the length is zero,
+ * <code>start + length - 1</code>. So, if the length is zero,
* then the end will be less that the start.
*
* @return The computed inclusive end value of this char span.
Modified: pivot/trunk/core/src/org/apache/pivot/text/FileSizeFormat.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/text/FileSizeFormat.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/text/FileSizeFormat.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/text/FileSizeFormat.java Thu Dec 31
18:02:57 2020
@@ -48,7 +48,7 @@ public final class FileSizeFormat extend
/**
* Formats a file size.
*
- * @param object A <tt>Number</tt> containing the length of the file, in
+ * @param object A {@code Number} containing the length of the file, in
* bytes. May be negative to indicate an unknown file size.
* @param stringBuffer The string buffer to which the formatted output will
* be appended.
Modified: pivot/trunk/core/src/org/apache/pivot/util/BooleanResult.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/BooleanResult.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/BooleanResult.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/BooleanResult.java Thu Dec 31
18:02:57 2020
@@ -17,7 +17,7 @@
package org.apache.pivot.util;
/**
- * An object holding a boolean value that can be used with a <tt>forEach</tt>
+ * An object holding a boolean value that can be used with a {@code forEach}
* or lambda expressionm, where the value used during the iteration must be
* final or effectively final.
*/
@@ -43,7 +43,7 @@ public class BooleanResult {
}
/**
- * Update the saved value by <tt>OR</tt>ing this new value
+ * Update the saved value by <code>OR</code>ing this new value
* with the saved value.
*
* @param value The new value to OR into the saved one.
@@ -53,7 +53,7 @@ public class BooleanResult {
}
/**
- * Update the saved value by <tt>AND</tt>ing this new value
+ * Update the saved value by <code>AND</code>ing this new value
* with the saved value.
*
* @param value The new value to AND into the saved one.
@@ -63,7 +63,7 @@ public class BooleanResult {
}
/**
- * Update the saved value by <tt>XOR</tt>ing this new value
+ * Update the saved value by <code>XOR</code>ing this new value
* with the saved value.
*
* @param value The new value to XOR into the saved one.
Modified: pivot/trunk/core/src/org/apache/pivot/util/CalendarDate.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/CalendarDate.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/CalendarDate.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/CalendarDate.java Thu Dec 31
18:02:57 2020
@@ -33,7 +33,7 @@ import org.apache.pivot.json.JSONSeriali
import org.apache.pivot.serialization.SerializationException;
/**
- * <tt>CalendarDate</tt> allows a specific day to be identified within the
+ * {@code CalendarDate} allows a specific day to be identified within the
* Gregorian calendar system. This identification has no association with any
* particular time zone and no notion of the time of day, except that
* conversions to/from Gregorian calendar may be affected by time zone, so
@@ -228,17 +228,17 @@ public final class CalendarDate implemen
}
/**
- * The year field. (e.g. <tt>2008</tt>).
+ * The year field. (e.g. <code>2008</code>).
*/
public final int year;
/**
- * The month field, 0-based. (e.g. <tt>2</tt> for March).
+ * The month field, 0-based. (e.g. <code>2</code> for March).
*/
public final int month;
/**
- * The day of the month, 0-based. (e.g. <tt>14</tt> for the 15th).
+ * The day of the month, 0-based. (e.g. <code>14</code> for the 15th).
*/
public final int day;
@@ -248,7 +248,7 @@ public final class CalendarDate implemen
* <p> This is only meaningful for conversions to/from Gregorian calendar
* (and implicitly then for difference calculations which use a calculated
* calendar value). Can be set in the non-default constructor
- * (for instance to GMT for the <tt>CalendarDateSpinnerData</tt> class).
+ * (for instance to GMT for the {@code CalendarDateSpinnerData} class).
* <p> Note: difference calculations will only be affected by the timezone
* if the two dates are in different ones, otherwise the calculations
* will be the same no matter what zone is used.
@@ -275,7 +275,7 @@ public final class CalendarDate implemen
public static final Time MIDNIGHT_TIME = new Time(0, 0, 0);
/**
- * Creates a new <tt>CalendarDate</tt> representing the current day in the
+ * Creates a new {@code CalendarDate} representing the current day in the
* default timezone and the default locale.
*/
public CalendarDate() {
@@ -283,7 +283,7 @@ public final class CalendarDate implemen
}
/**
- * Creates a new <tt>CalendarDate</tt> representing the current day in the
+ * Creates a new {@code CalendarDate} representing the current day in the
* given timezone and the default locale.
*
* @param timeZone The timezone to use for this calendar date.
@@ -293,7 +293,7 @@ public final class CalendarDate implemen
}
/**
- * Creates a new <tt>CalendarDate</tt> representing the day contained in
the
+ * Creates a new {@code CalendarDate} representing the day contained in the
* specified Gregorian calendar (assuming the default locale and the
default
* timezone).
*
@@ -307,7 +307,7 @@ public final class CalendarDate implemen
}
/**
- * Creates a new <tt>CalendarDate</tt> from the given {@link LocalDate}
+ * Creates a new {@code CalendarDate} from the given {@link LocalDate}
* (new in Java 8). This does not represent a moment in time, but only
* represents a date (as in year, month and day).
*
@@ -321,12 +321,12 @@ public final class CalendarDate implemen
}
/**
- * Creates a new <tt>CalendarDate</tt> representing the specified year,
+ * Creates a new {@code CalendarDate} representing the specified year,
* month, and day of month.
*
- * @param year The year field. (e.g. <tt>2008</tt>)
- * @param month The month field, 0-based. (e.g. <tt>2</tt> for March)
- * @param day The day of the month, 0-based. (e.g. <tt>14</tt> for the
15th)
+ * @param year The year field. (e.g. <code>2008</code>)
+ * @param month The month field, 0-based. (e.g. <code>2</code> for March)
+ * @param day The day of the month, 0-based. (e.g. <code>14</code> for the
15th)
* @see #MIN_CALENDAR_YEAR
* @see #MAX_CALENDAR_YEAR
*/
@@ -335,12 +335,12 @@ public final class CalendarDate implemen
}
/**
- * Creates a new <tt>CalendarDate</tt> representing the specified year,
+ * Creates a new {@code CalendarDate} representing the specified year,
* month, day of month, and timezone.
*
- * @param year The year field. (e.g. <tt>2008</tt>)
- * @param month The month field, 0-based. (e.g. <tt>2</tt> for March)
- * @param day The day of the month, 0-based. (e.g. <tt>14</tt> for the
15th)
+ * @param year The year field. (e.g. <code>2008</code>)
+ * @param month The month field, 0-based. (e.g. <code>2</code> for March)
+ * @param day The day of the month, 0-based. (e.g. <code>14</code> for the
15th)
* @param timeZone The timezone to assume for conversions and differences
(if
* {@code null} then the default TimeZone will be used).
* @see #MIN_CALENDAR_YEAR
@@ -395,8 +395,8 @@ public final class CalendarDate implemen
* Adds the specified number of days to this calendar date and returns the
* resulting calendar date. The number of days may be negative, in which
* case the result will be a date before this calendar date. <p> More
- * formally, it is defined that given calendar dates <tt>c1</tt> and
- * <tt>c2</tt>, the following will return {@code true}:
+ * formally, it is defined that given calendar dates <code>c1</code> and
+ * <code>c2</code>, the following will return {@code true}:
* <pre> c1.add(c2.subtract(c1)).equals(c2); </pre>
*
* @param days The number of days to add to (or subtract from if negative)
@@ -413,8 +413,8 @@ public final class CalendarDate implemen
* Adds the specified number of months to this calendar date and returns
the
* resulting calendar date. The number of months may be negative, in which
* case the result will be a date before this calendar date. <p> More
- * formally, it is defined that given calendar dates <tt>c1</tt> and
- * <tt>c2</tt>, the following will return {@code true}:
+ * formally, it is defined that given calendar dates <code>c1</code> and
+ * <code>c2</code>, the following will return {@code true}:
* <pre> c1.add(c2.subtract(c1)).equals(c2); </pre>
*
* @param months The number of months to add to (or subtract from if
negative)
@@ -431,8 +431,8 @@ public final class CalendarDate implemen
* Adds the specified number of years to this calendar date and returns the
* resulting calendar date. The number of years may be negative, in which
* case the result will be a date before this calendar date. <p> More
- * formally, it is defined that given calendar dates <tt>c1</tt> and
- * <tt>c2</tt>, the following will return {@code true}:
+ * formally, it is defined that given calendar dates <code>c1</code> and
+ * <code>c2</code>, the following will return {@code true}:
* <pre> c1.add(c2.subtract(c1)).equals(c2); </pre>
*
* @param years The number of years to add to (or subtract from if
negative)
@@ -452,13 +452,13 @@ public final class CalendarDate implemen
* represents a day before the specified calendar date, the difference will
* be negative. If the two calendar dates represent the same day, the
* difference will be zero.
- * <p> More formally, it is defined that given calendar dates <tt>c1</tt>
- * and <tt>c2</tt>, the following will return {@code true}:
+ * <p> More formally, it is defined that given calendar dates
<code>c1</code>
+ * and <code>c2</code>, the following will return {@code true}:
* <pre> c1.add(c2.subtract(c1)).equals(c2); </pre>
*
* @param calendarDate The calendar date to subtract from this calendar
date.
* @return The number of days in between this calendar date and
- * <tt>calendarDate</tt>.
+ * {@code calendarDate}.
*/
public int subtract(final CalendarDate calendarDate) {
GregorianCalendar c1 = toCalendar();
@@ -472,11 +472,11 @@ public final class CalendarDate implemen
/**
* Translates this calendar date to an instance of
- * <tt>GregorianCalendar</tt>, with the <tt>year</tt>, <tt>month</tt>, and
- * <tt>dayOfMonth</tt> fields set in the time zone set at construction with
+ * {@code GregorianCalendar}, with the <code>year</code>,
<code>month</code>, and
+ * <code>dayOfMonth</code> fields set in the time zone set at construction
with
* the default locale.
*
- * @return This calendar date as a <tt>GregorianCalendar</tt>.
+ * @return This calendar date as a {@code GregorianCalendar}.
*/
public GregorianCalendar toCalendar() {
return toCalendar(MIDNIGHT_TIME);
@@ -484,12 +484,12 @@ public final class CalendarDate implemen
/**
* Translates this calendar date along with the given time of day to an
instance of
- * <tt>GregorianCalendar</tt>, with the <tt>year</tt>, <tt>month</tt>, and
- * <tt>dayOfMonth</tt> fields set in the time zone set at construction
with the default
+ * {@code GregorianCalendar}, with the <code>year</code>,
<code>month</code>, and
+ * <code>dayOfMonth</code> fields set in the time zone set at construction
with the default
* locale.
*
* @param time The time of day.
- * @return This calendar date as a <tt>GregorianCalendar</tt>.
+ * @return This calendar date as a {@code GregorianCalendar}.
*/
public GregorianCalendar toCalendar(final Time time) {
GregorianCalendar calendar = new GregorianCalendar(this.year,
this.month, this.day + 1,
@@ -572,8 +572,8 @@ public final class CalendarDate implemen
}
/**
- * Returns a string representation of this calendar date in the <tt>ISO
- * 8601</tt> "calendar date" format, which is <tt>[YYYY]-[MM]-[DD]</tt>.
+ * Returns a string representation of this calendar date in the <code>ISO
+ * 8601</code> "calendar date" format, which is
<code>[YYYY]-[MM]-[DD]</code>.
*/
@Override
public String toString() {
@@ -606,10 +606,10 @@ public final class CalendarDate implemen
/**
* Creates a new date representing the specified date string. The date
- * string must be in the <tt>ISO 8601</tt> "calendar date" format, which is
- * <tt>[YYYY]-[MM]-[DD]</tt>.
+ * string must be in the <code>ISO 8601</code> "calendar date" format,
which is
+ * <code>[YYYY]-[MM]-[DD]</code>.
*
- * @param value A string in the form of <tt>[YYYY]-[MM]-[DD]</tt> (e.g.
+ * @param value A string in the form of <code>[YYYY]-[MM]-[DD]</code> (e.g.
* 2008-07-23).
* @return The {@code CalendarDate} corresponding to the input string.
*/
Modified: pivot/trunk/core/src/org/apache/pivot/util/ClassUtils.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/ClassUtils.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/ClassUtils.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/ClassUtils.java Thu Dec 31
18:02:57 2020
@@ -53,7 +53,7 @@ public final class ClassUtils {
*
* @param obj Any object.
* @return The result of what {@link Object#toString} would return without
- * any alternative implementation of <tt>toString()</tt> that may be
implemented
+ * any alternative implementation of {@code toString()} that may be
implemented
* in the class or any intervening superclass.
*/
public static String defaultToString(final Object obj) {
@@ -66,7 +66,7 @@ public final class ClassUtils {
*
* @param obj Any object.
* @return The result of what {@link Object#toString} would return without
- * any alternative implementation of <tt>toString()</tt> that may be
implemented
+ * any alternative implementation of {@code toString()} that may be
implemented
* in the class or any intervening superclass, except that the simple name
* of the class is used (without any package designation).
*/
@@ -76,7 +76,7 @@ public final class ClassUtils {
}
/**
- * Multi-class version of the <tt>instanceof</tt> operator.
+ * Multi-class version of the {@code instanceof} operator.
* <p> Specifically checks if the given object is an instance of any of the
* given classes.
* @param obj The (non-null) object to test.
Modified: pivot/trunk/core/src/org/apache/pivot/util/Constants.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/Constants.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/Constants.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/Constants.java Thu Dec 31
18:02:57 2020
@@ -26,8 +26,8 @@ public final class Constants {
}
/**
- * The non-default buffer size to use for <tt>BufferedReader</tt> and
- * and <tt>BufferedWriter</tt>.
+ * The non-default buffer size to use for {@code BufferedReader} and
+ * and {@code BufferedWriter}.
* <p> This should be larger than the default value (which seems to be
* 8192 as of Java 7), or there is no point in using it.
*/
Modified: pivot/trunk/core/src/org/apache/pivot/util/EmptyIterator.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/EmptyIterator.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/EmptyIterator.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/EmptyIterator.java Thu Dec 31
18:02:57 2020
@@ -25,7 +25,7 @@ import java.util.NoSuchElementException;
* <p> This is used (for instance) for {@link
org.apache.pivot.collections.HashMap}
* when a hash bucket list is empty, so that iteration through the bucket list
* doesn't have to be special-cased.
- * <p>Note: for Java 8 we have taken out the implementation of the
<tt>remove()</tt>
+ * <p>Note: for Java 8 we have taken out the implementation of the {@code
remove()}
* method because the interface now implements it as we need it as a default
method.
*/
public class EmptyIterator<T> implements Iterator<T> {
Modified: pivot/trunk/core/src/org/apache/pivot/util/ImmutableIterator.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/ImmutableIterator.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/ImmutableIterator.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/ImmutableIterator.java Thu Dec
31 18:02:57 2020
@@ -21,9 +21,9 @@ import java.util.Iterator;
/**
* Immutable implementation of the {@link Iterator} interface.
* <p>The only methods that have actual implementations (that just
- * defer to the underlying <tt>Iterator</tt>) are: {@link #hasNext}
+ * defer to the underlying {@code Iterator}) are: {@link #hasNext}
* and {@link #next}.
- * <p>Note: the <tt>remove()</tt> method implementation here has
+ * <p>Note: the {@code remove()} method implementation here has
* been taken out because there is now a default implementation
* in the {@link Iterator} interface itself in Java 8.
* @param <T> The type of elements we are iterating over.
Modified: pivot/trunk/core/src/org/apache/pivot/util/ListenerList.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/ListenerList.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/ListenerList.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/ListenerList.java Thu Dec 31
18:02:57 2020
@@ -196,7 +196,7 @@ public abstract class ListenerList<T> im
* Get the indexed element in the list.
*
* @param index Position of the element to retrieve.
- * @return The element at position <tt>index</tt>.
+ * @return The element at position {@code index}.
* @throws IndexOutOfBoundsException if the index is out of range.
*/
public T get(final int index) {
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=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/StringUtils.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/StringUtils.java Thu Dec 31
18:02:57 2020
@@ -61,8 +61,8 @@ public final class StringUtils {
* Convert a string of characters into a hex value string.
*
* @param charSequence The string of characters to represent.
- * @return A string in the form of <tt>"[xx,xx,xx...]"</tt>
- * where the "xx" are the hex representations of each character.
+ * @return A string in the form of
<code>"[<i>xx</i>,<i>xx</i>,<i>xx</i>...]"</code>
+ * where the "<i>xx</i>" are the hex representations of each character.
*/
public static String toHexString(final CharSequence charSequence) {
StringBuilder builder = new StringBuilder(charSequence.length() * 3 +
1);
@@ -132,11 +132,11 @@ public final class StringUtils {
* and supports more features. Specifically it will recognize:
* <ul>
* <li>{@code true} or {@code false} 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>
+ * <li><code>yes</code> or <code>no</code> in mixed case.</li>
+ * <li><code>on</code> or <code>off</code> in mixed case.</li>
+ * <li><code>T</code> or <code>F</code> in mixed case.</li>
+ * <li><code>Y</code> or <code>N</code> in mixed case.</li>
+ * <li><code>1</code> or <code>0</code>.</li>
* </ul>
*
* @param input The string value to convert to a boolean.
@@ -174,7 +174,7 @@ public final class StringUtils {
/**
* Given an iterable list of items, construct a string representation of
the list
* that looks like:
- * <pre>[item1, item2, ...]</pre>.
+ * <p><code>[<i>item1</i>, <i>item2</i>, ...]</code></p>
*
* @param <T> The type of items in the list.
* @param list The iterable list of items.
@@ -189,9 +189,9 @@ public final class StringUtils {
/**
* Given an iterable list of items, construct a string representation of
the list
* that looks like:
- * <pre>[item1, item2, ...]</pre>
+ * <p><code>[<i>item1</i>, <i>item2</i>, ...]</code></p>
* appending the results to the given string builder for further use.
- * <p> If the {@link StringBuilder} has any preceding text (that is,
length > 0)
+ * <p> If the {@link StringBuilder} has any preceding text (that is,
{@code length > 0})
* then append a blank before the list representation.
*
* @param <T> The type of items in the list.
Modified: pivot/trunk/core/src/org/apache/pivot/util/Time.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/Time.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/Time.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/Time.java Thu Dec 31 18:02:57
2020
@@ -302,7 +302,7 @@ public final class Time implements Compa
}
/**
- * Construct a <tt>Time</tt> from a {@link LocalTime}, rounding
+ * Construct a {@code Time} from a {@link LocalTime}, rounding
* up the nanosecond value to our milliseconds.
*
* @param localTime The local time to convert.
@@ -335,7 +335,7 @@ public final class Time implements Compa
* represent the same time, the difference will be zero.
*
* @param time The time to subtract from this time.
- * @return The number of milliseconds in between this time and
<tt>time</tt>.
+ * @return The number of milliseconds in between this time and {@code
time}.
*/
public int subtract(final Time time) {
Utils.checkNull(time, "time");
@@ -423,12 +423,12 @@ public final class Time implements Compa
/**
* Creates a new time representing the specified time string. The time
- * string must be in the full <tt>ISO 8601</tt> extended "time" format,
- * which is <tt>[hh]:[mm]:[ss]</tt>. An optional millisecond suffix of the
- * form <tt>.[nnn]</tt> is also supported.
+ * string must be in the full <code>ISO 8601</code> extended "time" format,
+ * which is <code>[hh]:[mm]:[ss]</code>. An optional millisecond suffix of
the
+ * form <code>.[nnn]</code> is also supported.
*
- * @param value A string in the form of <tt>[hh]:[mm]:[ss]</tt> or
- * <tt>[hh]:[mm]:[ss].[nnn]</tt> (e.g. 17:19:20 or 17:19:20.412).
+ * @param value A string in the form of <code>[hh]:[mm]:[ss]</code> or
+ * <code>[hh]:[mm]:[ss].[nnn]</code> (e.g. 17:19:20 or 17:19:20.412).
* @return The {@code Time} value corresponding to the input string.
*/
public static Time decode(final String value) {
Modified: pivot/trunk/core/src/org/apache/pivot/util/Utils.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/Utils.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/Utils.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/Utils.java Thu Dec 31 18:02:57
2020
@@ -321,8 +321,8 @@ public final class Utils {
* @param start The start of the acceptable range (inclusive).
* @param end The end of the acceptable range (inclusive).
*
- * @throws IllegalArgumentException if {@code end} is < {@code start}.
- * @throws IndexOutOfBoundsException if {@code index} is < {@code
start} or > {@code end}.
+ * @throws IllegalArgumentException if {@code end < start}.
+ * @throws IndexOutOfBoundsException if {@code index < start} or {@code
index > end}.
*/
public static void checkIndexBounds(final int index, final int start,
final int end) {
if (end < start) {
@@ -340,7 +340,7 @@ public final class Utils {
*
* @param index The candidate index into the zero-based range.
* @param size The size of the array/list/etc. (so the proper range is
{@code 0 .. size - 1}).
- * @throws IndexOutOfBoundsException if the {@code index} is < 0 or
>= {@code size}.
+ * @throws IndexOutOfBoundsException if the {@code index < 0} or {@code
index >= size}.
*/
public static void checkZeroBasedIndex(final int index, final int size) {
if (index < 0 || index >= size) {
@@ -357,10 +357,10 @@ public final class Utils {
* @param start The start of the acceptable range (inclusive).
* @param end The end of the acceptable range (inclusive).
*
- * @throws IllegalArgumentException if {@code end} is < {@code start},
or
- * if {@code count} or {@code start} are < zero.
- * @throws IndexOutOfBoundsException if {@code index} is < {@code
start} or
- * if {@code index + start} is > {@code end}.
+ * @throws IllegalArgumentException if {@code end < start}, or
+ * if {@code count} or {@code start} are {@code < zero}.
+ * @throws IndexOutOfBoundsException if {@code index < start} or
+ * if {@code index + count > end}.
*/
public static void checkIndexBounds(final int index, final int count,
final int start, final int end) {
if (end < start) {
@@ -389,9 +389,9 @@ public final class Utils {
* @param start The start of the acceptable range (inclusive).
* @param end The end of the acceptable range (inclusive).
*
- * @throws IllegalArgumentException if {@code endIndex} is < {@code
startIndex}.
- * @throws IndexOutOfBoundsException if {@code startIndex} is < {@code
start} or
- * {@code endIndex} is > {@code end}.
+ * @throws IllegalArgumentException if {@code startIndex > endIndex}.
+ * @throws IndexOutOfBoundsException if {@code startIndex < start} or
+ * {@code endIndex > end}.
*/
public static void checkTwoIndexBounds(final int startIndex, final int
endIndex, final int start, final int end) {
if (startIndex > endIndex) {
Modified: pivot/trunk/core/src/org/apache/pivot/util/Vote.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/Vote.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/Vote.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/Vote.java Thu Dec 31 18:02:57
2020
@@ -41,10 +41,10 @@ public enum Vote {
* For a vote tally to work correctly the initial value must be {@link
#APPROVE}.
* <p>The tallying algorithm is as follows:
* <ul>
- * <li>New vote is {@link #APPROVE} -> result is previous result.
- * <li>New vote is {@link #DENY} -> result is new vote (that is,
<tt>DENY</tt>).
- * <li>New vote is {@link #DEFER} -> result is <tt>DENY</tt> if
previous was
- * <tt>DENY</tt>, otherwise <tt>DEFER</tt>.
+ * <li>New vote is {@link #APPROVE} {@code ->} result is previous result.
+ * <li>New vote is {@link #DENY} {@code ->} result is new vote (that is,
<code>DENY</code>).
+ * <li>New vote is {@link #DEFER} {@code ->} result is <code>DENY</code>
if previous was
+ * <code>DENY</code>, otherwise <code>DEFER</code>.
* </ul>
*
* @param vote The new vote to tally.
Modified: pivot/trunk/core/src/org/apache/pivot/util/VoteResult.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/util/VoteResult.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/util/VoteResult.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/util/VoteResult.java Thu Dec 31
18:02:57 2020
@@ -18,7 +18,7 @@ package org.apache.pivot.util;
/**
* An object holding the result of a {@link Vote#tally} that can be
- * used with a <tt>forEach</tt> or lambda expression, where the value
+ * used with a {@code forEach} or lambda expression, where the value
* used during the iteration must be final or effectively final.
*/
public class VoteResult {
@@ -44,7 +44,7 @@ public class VoteResult {
/**
* Tally the internal vote with the next vote in line.
- * <p> The internal <tt>Vote</tt> is updated with the
+ * <p> The internal {@code Vote} is updated with the
* result of the vote tally.
*
* @param vote The next vote to tally against all the
@@ -56,7 +56,7 @@ public class VoteResult {
}
/**
- * @return The final tallied <tt>Vote</tt> value.
+ * @return The final tallied {@code Vote} value.
*/
public Vote get() {
return result;
Modified: pivot/trunk/core/src/org/apache/pivot/xml/Element.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/xml/Element.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/xml/Element.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/xml/Element.java Thu Dec 31 18:02:57
2020
@@ -287,7 +287,7 @@ public class Element extends Node implem
* Determines the index of an attribute.
*
* @param attribute The attribute to look up.
- * @return The index of the attribute, if found; otherwise <tt>-1</tt>.
+ * @return The index of the attribute, if found; otherwise
<code>-1</code>.
*/
@Override
public int indexOf(Attribute attribute) {
@@ -729,7 +729,7 @@ public class Element extends Node implem
/**
* Determines the index of the given node within this element.
*
- * @return The index of the node, or <tt>-1</tt> if the node does not exist
+ * @return The index of the node, or <code>-1</code> if the node does not
exist
* in this element.
*/
@Override
Modified: pivot/trunk/demos/src/org/apache/pivot/demos/itunes/SearchDemo.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/demos/src/org/apache/pivot/demos/itunes/SearchDemo.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/demos/src/org/apache/pivot/demos/itunes/SearchDemo.java
(original)
+++ pivot/trunk/demos/src/org/apache/pivot/demos/itunes/SearchDemo.java Thu Dec
31 18:02:57 2020
@@ -98,7 +98,7 @@ public class SearchDemo implements Appli
* Executes a search.
*
* @param term The search term.
- * @throws IllegalArgumentException If <tt>term</tt> is {@code null} or
+ * @throws IllegalArgumentException If {@code term} is {@code null} or
* empty.
* @throws IllegalStateException If a query is already executing.
*/
Modified:
pivot/trunk/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/BXMLExplorerDocument.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/BXMLExplorerDocument.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
---
pivot/trunk/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/BXMLExplorerDocument.java
(original)
+++
pivot/trunk/tutorials/src/org/apache/pivot/tutorials/bxmlexplorer/BXMLExplorerDocument.java
Thu Dec 31 18:02:57 2020
@@ -74,7 +74,7 @@ public class BXMLExplorerDocument extend
private File file;
private Component loadedComponent;
/**
- * Maps the WTK widgets -> bxml:id values.
+ * Maps the WTK widgets {@code -> bxml:id} values.
*/
private HashMap<Object, String> widgetToID = null;
private HashMap<Object, TreeNode> componentToTreeNode = null;
Modified: pivot/trunk/web/src/org/apache/pivot/web/Query.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/web/src/org/apache/pivot/web/Query.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/web/src/org/apache/pivot/web/Query.java (original)
+++ pivot/trunk/web/src/org/apache/pivot/web/Query.java Thu Dec 31 18:02:57 2020
@@ -275,7 +275,7 @@ public abstract class Query<V> extends I
* PUT requests, this number will increment in between the
* {@link QueryListener#connected(Query) connected} and
* {@link QueryListener#requestSent(Query) requestSent} phases of the
- * <tt>QueryListener</tt> lifecycle methods. Interested listeners can poll
+ * {@code QueryListener} lifecycle methods. Interested listeners can poll
* for this value during that phase.
* @return Number of bytes sent by POST or PUT requests, or 0 for GET and
* DELETE.
@@ -291,7 +291,7 @@ public abstract class Query<V> extends I
* solicit response content from the server. <p> This number will increment
* in between the {@link QueryListener#requestSent(Query) requestSent} and
* {@link QueryListener#responseReceived(Query) responseReceived} phases of
- * the <tt>QueryListener</tt> lifecycle methods. Interested listeners can
+ * the {@code QueryListener} lifecycle methods. Interested listeners can
* poll for this value during that phase.
* @return The number of bytes received.
*/
@@ -302,11 +302,11 @@ public abstract class Query<V> extends I
/**
* Gets the number of bytes that are expected to be received from the
server
* in the body of the server's HTTP response. This value reflects the
- * <tt>Content-Length</tt> HTTP response header and is thus merely an
+ * <code>Content-Length</code> HTTP response header and is thus merely an
* expectation. The actual total number of bytes that will be received is
* not known for certain until the full response has been received. <p> If
- * the server did not specify a <tt>Content-Length</tt> HTTP response
- * header, a value of <tt>-1</tt> will be returned to indicate that this
+ * the server did not specify a <code>Content-Length</code> HTTP response
+ * header, a value of <code>-1</code> will be returned to indicate that
this
* value is unknown.
* @return The expected number of bytes to received based on the content
length.
*/
Modified: pivot/trunk/web/src/org/apache/pivot/web/QueryException.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/web/src/org/apache/pivot/web/QueryException.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/web/src/org/apache/pivot/web/QueryException.java (original)
+++ pivot/trunk/web/src/org/apache/pivot/web/QueryException.java Thu Dec 31
18:02:57 2020
@@ -44,7 +44,7 @@ public class QueryException extends Task
* Returns the HTTP status code corresponding to the exception.
*
* @return An HTTP status code reflecting the nature of the exception, or
- * <tt>0</tt> if the HTTP status is not known.
+ * <code>0</code> if the HTTP status is not known.
*/
public int getStatus() {
return status;
Modified: pivot/trunk/web/src/org/apache/pivot/web/package.html
URL:
http://svn.apache.org/viewvc/pivot/trunk/web/src/org/apache/pivot/web/package.html?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/web/src/org/apache/pivot/web/package.html (original)
+++ pivot/trunk/web/src/org/apache/pivot/web/package.html Thu Dec 31 18:02:57
2020
@@ -31,23 +31,23 @@ limitations under the License.
</tr>
</thead>
<tr>
- <td><tt>POST</tt></td>
- <td><tt>INSERT</tt></td>
+ <td><code>POST</code></td>
+ <td><code>INSERT</code></td>
<td>Create</td>
</tr>
<tr>
- <td><tt>GET</tt></td>
- <td><tt>SELECT</tt></td>
+ <td><code>GET</code></td>
+ <td><code>SELECT</code></td>
<td>Read</td>
</tr>
<tr>
- <td><tt>PUT</tt></td>
- <td><tt>UPDATE</tt></td>
+ <td><code>PUT</code></td>
+ <td><code>UPDATE</code></td>
<td>Update</td>
</tr>
<tr>
- <td><tt>DELETE</tt></td>
- <td><tt>DELETE</tt></td>
+ <td><code>DELETE</code></td>
+ <td><code>DELETE</code></td>
<td>Delete</td>
</tr>
</table>
Modified:
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraCalendarSkin.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraCalendarSkin.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
---
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraCalendarSkin.java
(original)
+++
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraCalendarSkin.java
Thu Dec 31 18:02:57 2020
@@ -233,7 +233,7 @@ public class TerraCalendarSkin extends C
/**
* {@link KeyCode#ENTER ENTER} 'presses' the button.<br>
* {@link KeyCode#UP UP}, {@link KeyCode#DOWN DOWN},
- * {@link KeyCode#LEFT LEFT} & {@link KeyCode#RIGHT RIGHT} Navigate
+ * {@link KeyCode#LEFT LEFT} and {@link KeyCode#RIGHT RIGHT} Navigate
* around the date grid.
*/
@Override
Modified:
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraScrollBarSkin.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraScrollBarSkin.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
---
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraScrollBarSkin.java
(original)
+++
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraScrollBarSkin.java
Thu Dec 31 18:02:57 2020
@@ -46,8 +46,8 @@ public class TerraScrollBarSkin extends
ScrollBarValueListener {
/**
* Encapsulates the code needed to perform timer-controlled scrolling. This
- * class is used by <tt>TerraScrollBarSkin</tt> (automatic block increment
- * scrolling) and <tt>ScrollButtonSkin</tt> (automatic unit increment
+ * class is used by {@code TerraScrollBarSkin} (automatic block increment
+ * scrolling) and {@code ScrollButtonSkin} (automatic unit increment
* scrolling).
*/
protected class AutomaticScroller {
@@ -61,12 +61,12 @@ public class TerraScrollBarSkin extends
* Starts scrolling this skin's scroll bar, stopping the scroll when
the
* specified value has been reached.
*
- * @param directionArgument <tt>1</tt> to adjust the scroll bar's value
- * larger; <tt>-1</tt> to adjust it smaller
+ * @param directionArgument <code>1</code> to adjust the scroll bar's
value
+ * larger; <code>-1</code> to adjust it smaller
* @param incrementTypeArgument Determines whether we'll use the scroll
* bar's unit increment or the block increment when scrolling
* @param stopValueArgument The value which, once reached, will stop
the
- * automatic scrolling. Use <tt>-1</tt> to specify no stop value
+ * automatic scrolling. Use <code>-1</code> to specify no stop value
* @exception IllegalStateException If automatic scrolling of any
scroll
* bar is already in progress. Only one scroll bar may be automatically
* scrolled at one time
@@ -1044,7 +1044,7 @@ public class TerraScrollBarSkin extends
* @param component The scroll bar.
* @param scrollType Unit or block scrolling.
* @param scrollAmount The amount of scrolling.
- * @param wheelRotation <tt>-1</tt> or <tt>1</tt> for backward or forward
+ * @param wheelRotation <code>-1</code> or <code>1</code> for backward or
forward
* scrolling, respectively.
* @param x The x-coordinate of the event in the scroll bar's coordinate
* space.
@@ -1085,14 +1085,14 @@ public class TerraScrollBarSkin extends
/**
* Gets the scale factor that allows us to translate pixel values to scroll
* bar values and vice versa. This assumes that the range of pixels spans
- * from the last pixel of <tt>scrollUpButton</tt> to the first pixel of
- * <tt>scrollDownButton</tt> and excludes the pixels taken up by
- * <tt>handle</tt>. <p> To map from scroll bar values (<i>real values</i>)
+ * from the last pixel of {@code scrollUpButton} to the first pixel of
+ * {@code scrollDownButton} and excludes the pixels taken up by
+ * {@code handle}. <p> To map from scroll bar values (<i>real values</i>)
* to pixel values, you multiply by the value scale. To map from pixel
* values back to real values, you divide by the value scale.
*
- * @return <tt><number of legal pixel values> / <number of legal
- * real values></tt>
+ * @return {@code <number of legal pixel values> / <number of legal
+ * real values>}
*/
private float getValueScale() {
ScrollBar scrollBar = (ScrollBar) getComponent();
Modified:
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
---
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
(original)
+++
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
Thu Dec 31 18:02:57 2020
@@ -61,8 +61,8 @@ public class TerraSpinnerSkin extends Co
* Starts spinning the specified spinner.
*
* @param spinnerArgument The spinner to spin
- * @param directionArgument <tt>1</tt> to adjust the spinner's selected
- * index larger; <tt>-1</tt> to adjust it smaller
+ * @param directionArgument <code>1</code> to adjust the spinner's
selected
+ * index larger; <code>-1</code> to adjust it smaller
* @exception IllegalStateException If automatic spinner of any spinner
* is already in progress. Only one spinner may be automatically spun
at
* one time
Modified:
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
---
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java
(original)
+++
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java
Thu Dec 31 18:02:57 2020
@@ -704,7 +704,7 @@ public class TerraTextInputSkin extends
* and the maximum height of any character in the font.
*
* @param font The new font to use.
- * @throws IllegalArgumentException if the <tt>font</tt> argument is
{@code null}.
+ * @throws IllegalArgumentException if the {@code font} argument is {@code
null}.
*/
public final void setFont(final Font font) {
Utils.checkNull(font, "font");
Modified:
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java
(original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java
Thu Dec 31 18:02:57 2020
@@ -654,8 +654,7 @@ public final class TerraTheme extends Th
/**
* @return A brighter version of the specified color. Specifically, it
* increases the brightness (in the HSB color model) by the
- * <tt>colorMultiplier</tt> factor and <tt>themeIsDark</tt> flag already
- * set.
+ * {@link #brightenColorMultiplier} factor already set.
* @param color The color to brighten.
*/
public static Color brighten(final Color color) {
@@ -665,7 +664,7 @@ public final class TerraTheme extends Th
/**
* @return A darker version of the specified color. Specifically, it
* decreases the brightness (in the HSB color model) by the
- * <tt>colorMultiplier</tt> factor and <tt>themeDark</tt> flag already set.
+ * {@link #darkenColorMultiplier} factor already set.
* @param color The color to darken.
*/
public static Color darken(final Color color) {
Modified:
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
---
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
(original)
+++
pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
Thu Dec 31 18:02:57 2020
@@ -81,7 +81,7 @@ public class TerraTreeViewSkin extends C
* Iterates through the visible nodes. For callers who wish to know the
path
* of each visible node, using this iterator will be much more efficient
* than manually iterating over the visible nodes and calling
- * <tt>getPath()</tt> on each node.
+ * {@code getPath()} on each node.
*/
protected final class VisibleNodeIterator implements Iterator<NodeInfo> {
private int index;
@@ -168,8 +168,8 @@ public class TerraTreeViewSkin extends C
* are expanded and collapsed, the row index of any given node in the
* tree will change.
*
- * @return The row index of the current node, or <tt>-1</tt> if
- * <tt>next()</tt> has not yet been called.
+ * @return The row index of the current node, or <code>-1</code> if
+ * {@code next()} has not yet been called.
*/
public int getRowIndex() {
return (path == null ? -1 : index - 1);
@@ -178,7 +178,7 @@ public class TerraTreeViewSkin extends C
/**
* Gets the path of the node last returned by a call to {@link
#next()}.
*
- * @return The path to the node, or {@code null} if <tt>next()</tt> has
+ * @return The path to the node, or {@code null} if {@code next()} has
* not yet been called.
*/
public Path getPath() {
@@ -189,13 +189,13 @@ public class TerraTreeViewSkin extends C
/**
* An internal data structure that keeps track of skin-related metadata for
* a tree node. The justification for the existence of this class lies in
- * the <tt>visibleNodes</tt> data structure, which is a flat list of nodes
+ * the {@code visibleNodes} data structure, which is a flat list of nodes
* that are visible at any given time. In this context, visible means that
* their parent hierarchy is expanded, <b>not</b> that they are being
- * painted. This list, combined with <tt>getNodeHeight()</tt>, enables us
to
+ * painted. This list, combined with {@code getNodeHeight()}, enables us to
* quickly determine which nodes to paint given a graphics clip rect. It
* also enables us to quickly traverse the tree view when handling key
- * events. <p> NOTE: some of this data is managed by <tt>TreeView</tt> and
+ * events. <p> NOTE: some of this data is managed by {@code TreeView} and
* cached here to provide further optimizations during painting and user
* input.
*/
@@ -389,9 +389,9 @@ public class TerraTreeViewSkin extends C
/**
* Loads this branch info's children. The children list is initialized
* to {@code null} and loaded lazily to allow the skin to only create
- * <tt>NodeInfo</tt> objects for the nodes that it actually needs in
+ * {@code NodeInfo} objects for the nodes that it actually needs in
* order to paint. Thus, it is the responsibility of the skin to check
- * if <tt>children</tt> is null and call <tt>loadChildren()</tt> if
+ * if {@code children} is null and call {@code loadChildren()} if
* necessary.
*/
@SuppressWarnings("unchecked")
@@ -1349,7 +1349,7 @@ public class TerraTreeViewSkin extends C
* @param parentBranchInfo The branch info of the parent node.
* @param index The index of the first child node to remove from the
visible
* nodes sequence.
- * @param count The number of child nodes to remove, or <tt>-1</tt> to
remove
+ * @param count The number of child nodes to remove, or <code>-1</code> to
remove
* all child nodes from the visible nodes sequence.
*/
private void removeVisibleNodes(BranchInfo parentBranchInfo, int index,
int count) {
@@ -1420,7 +1420,7 @@ public class TerraTreeViewSkin extends C
}
/**
- * Clears our <tt>NodeInfo</tt> hierarchy of the specified cached field.
+ * Clears our {@code NodeInfo} hierarchy of the specified cached field.
*
* @param mask The bitmask specifying which field to clear.
*/
Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/package.html
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/package.html?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/package.html
(original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/package.html Thu
Dec 31 18:02:57 2020
@@ -41,7 +41,7 @@ is shown below:
<p>
The font, color palette, and message icons are defined in a JSON file that
should contain a
-<tt>Map</tt> containing the following properties:
+<code>Map</code> containing the following properties:
</p>
<table border="1" cellpadding="5">
<tr>
@@ -50,24 +50,24 @@ The font, color palette, and message ico
<th>Description</th>
</tr>
<tr valign="top">
-<td><tt>font</tt></td>
-<td><tt>String</tt></td>
+<td><code>font</code></td>
+<td><code>String</code></td>
<td>
The default theme font; must be understandable by
-<tt>java.awt.Font.decode()</tt>.
+<code>java.awt.Font.decode()</code>.
</td>
</tr>
<tr valign="top">
-<td><tt>colorMultiplier</tt></td>
-<td><tt>Number</tt></td>
+<td><code>colorMultiplier</code></td>
+<td><code>Number</code></td>
<td>
The default multiplication delta (+/-) for generating the darker and lighter
version
of any "base color palette", in the range [0.0..1.0].
</td>
</tr>
<tr valign="top">
-<td><tt>themeIsDark</tt></td>
-<td><tt>boolean</tt></td>
+<td><code>themeIsDark</code></td>
+<td><code>boolean</code></td>
<td>
Tell if the theme is dark.
Usually this means that (if true) any color will be transformed in the
opposite way
@@ -76,8 +76,8 @@ Set true if dark, false otherwise (defau
</td>
</tr>
<tr valign="top">
-<td><tt>themeIsFlat</tt></td>
-<td><tt>boolean</tt></td>
+<td><code>themeIsFlat</code></td>
+<td><code>boolean</code></td>
<td>
Tell if the theme is flat.
Usually this means that (if true) any border/shadow will not be drawn.
@@ -85,8 +85,8 @@ Set true if flat, false otherwise (defau
</td>
</tr>
<tr valign="top">
-<td><tt>transitionEnabled</tt></td>
-<td><tt>boolean</tt></td>
+<td><code>transitionEnabled</code></td>
+<td><code>boolean</code></td>
<td>
Tell if the theme has transitions enabled.
Usually this means that (if false) any effect/transition will not be drawn.
@@ -94,11 +94,11 @@ Set true if enabled (default), false oth
</td>
</tr>
<tr valign="top">
-<td><tt>colors</tt></td>
-<td><tt>List<String></tt></td>
+<td><code>colors</code></td>
+<td><code>List<String></code></td>
<td>
This list should contain eight colors in a form understandable by
-<tt>java.awt.Color.decode()</tt>. This list represents the theme's
+<code>java.awt.Color.decode()</code>. This list represents the theme's
"base color palette", from which the full color palette is
derived. Each of these eight colors will be expanded to three
colors in the final palette: a darker version, the color itself,
@@ -108,34 +108,34 @@ colors are the colors in the middle colu
</td>
</tr>
<tr valign="top">
-<td><tt>messageIcons</tt></td>
-<td><tt>Map</tt></td>
+<td><code>messageIcons</code></td>
+<td><code>Map</code></td>
<td>
Message icon names; must include values for "error", "warning", "question",
and "info".
-Names are specified as resource named relative to the <tt>TerraTheme</tt>
class.
+Names are specified as resource named relative to the <code>TerraTheme</code>
class.
</td>
</tr>
<tr valign="top">
-<td><tt>smallMessageIcons</tt></td>
-<td><tt>Map</tt></td>
+<td><code>smallMessageIcons</code></td>
+<td><code>Map</code></td>
<td>
Small message icon names; must include values for "error", "warning",
"question", and "info".
-Names are specified as resource named relative to the <tt>TerraTheme</tt>
class.
+Names are specified as resource named relative to the <code>TerraTheme</code>
class.
</td>
</tr>
<tr valign="top">
-<td><tt>defaultBackgroundColor</tt></td>
-<td><tt>String</tt></td>
+<td><code>defaultBackgroundColor</code></td>
+<td><code>String</code></td>
<td>
-The theme's default background color in hexadecimal format, for example
<tt>#ffffff</tt>.
+The theme's default background color in hexadecimal format, for example
<code>#ffffff</code>.
If not set, a generic default will be used.
</td>
</tr>
<tr valign="top">
-<td><tt>defaultForegroundColor</tt></td>
-<td><tt>String</tt></td>
+<td><code>defaultForegroundColor</code></td>
+<td><code>String</code></td>
<td>
-The theme's default foreground color in hexadecimal format, for example
<tt>#000000</tt>.
+The theme's default foreground color in hexadecimal format, for example
<code>#000000</code>.
If not set, a generic default will be used.
</td>
</tr>
@@ -143,13 +143,13 @@ If not set, a generic default will be us
<br>
<p>
-By default, the theme definition in <tt>TerraTheme_default.json</tt> is used,
-but can be overridden via the <tt>org.apache.pivot.wtk.skin.terra.location</tt>
+By default, the theme definition in <code>TerraTheme_default.json</code> is
used,
+but can be overridden via the
<code>org.apache.pivot.wtk.skin.terra.location</code>
property.<br>
For Example, in VM arguments set:<br>
-<tt>-Dorg.apache.pivot.wtk.skin.terra.location=TerraTheme_dark.json</tt><br>
+<code>-Dorg.apache.pivot.wtk.skin.terra.location=TerraTheme_dark.json</code><br>
or<br>
-<tt>-Dorg.apache.pivot.wtk.skin.terra.location=/org/apache/pivot/tests/TerraTheme_test.json</tt><br>
+<code>-Dorg.apache.pivot.wtk.skin.terra.location=/org/apache/pivot/tests/TerraTheme_test.json</code><br>
</p>
<br>
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Bounds.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Bounds.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Bounds.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Bounds.java Thu Dec 31 18:02:57
2020
@@ -135,7 +135,7 @@ public final class Bounds implements Ser
* four needed values.
*
* @param bounds The sequence containing the bounds values,
- * in the order of <tt>[ x, y, width, height ]</tt>
+ * in the order of <code>[ x, y, width, height ]</code>
* @throws IllegalArgumentException if the bounds argument is {@code null}.
*/
public Bounds(final Sequence<?> bounds) {
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=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/BrowserApplicationContext.java Thu
Dec 31 18:02:57 2020
@@ -42,14 +42,14 @@ public final class BrowserApplicationCon
* Applet used to host applications in a web browser. <p> This applet
* supports the following parameters:
* <ul>
- * <li><tt>application_class_name</tt> - the class name of the application
+ * <li><code>application_class_name</code> - the class name of the
application
* to launch.</li>
- * <li><tt>startup_properties</tt> - startup properties to
+ * <li><code>startup_properties</code> - 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. "{@code a=1&b=2}".</li>
+ * <li><code>system_properties</code> - system properties
* to set at startup. Properties use HTTP query string syntax; e.g.
- * "a=1&b=2" (trusted applets only).</li>
+ * "{@code a=1&b=2}" (trusted applets only).</li>
* </ul>
*/
public static final class HostApplet extends Applet {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java Thu Dec 31 18:02:57
2020
@@ -444,7 +444,7 @@ public abstract class Button extends Com
* transition (for instance), or similar timing.
*
* @param delay The delay value (in milliseconds) to use when queuing the
action,
- * or <tt>0</tt> to use no delay.
+ * or <code>0</code> to use no delay.
*/
public void setQueuedActionDelay(int delay) {
Utils.checkNonNegative(delay, "delay");
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Calendar.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Calendar.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Calendar.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Calendar.java Thu Dec 31 18:02:57
2020
@@ -157,10 +157,10 @@ public class Calendar extends Container
/**
* Sets the selected date to the date represented by the specified date
- * string. The date string must be in the <tt>ISO 8601</tt> "calendar date"
- * format, which is <tt>[YYYY]-[MM]-[DD]</tt>.
+ * string. The date string must be in the <code>ISO 8601</code> "calendar
date"
+ * format, which is <code>[YYYY]-[MM]-[DD]</code>.
*
- * @param selectedDate A string in the form of <tt>[YYYY]-[MM]-[DD]</tt>
+ * @param selectedDate A string in the form of
<code>[YYYY]-[MM]-[DD]</code>
* (e.g. 2008-07-23)
* @throws IllegalArgumentException if the given date is {@code null}.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButton.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButton.java?rev=1884991&r1=1884990&r2=1884991&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButton.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButton.java Thu Dec 31
18:02:57 2020
@@ -177,10 +177,10 @@ public class CalendarButton extends Butt
/**
* Sets the selected date to the date represented by the specified date
- * string. The date string must be in the <tt>ISO 8601</tt> "calendar date"
- * format, which is <tt>[YYYY]-[MM]-[DD]</tt>.
+ * string. The date string must be in the <code>ISO 8601</code> "calendar
date"
+ * format, which is <code>[YYYY]-[MM]-[DD]</code>.
*
- * @param selectedDate A string in the form of <tt>[YYYY]-[MM]-[DD]</tt>
+ * @param selectedDate A string in the form of
<code>[YYYY]-[MM]-[DD]</code>
* (e.g. 2008-07-23)
* @throws IllegalArgumentException if the selected data value is {@code
null}.
*/
