You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by gb...@apache.org on 2009/05/28 15:59:56 UTC
svn commit: r779607 - in /incubator/pivot/trunk:
charts/src/pivot/charts/skin/ core/src/pivot/collections/
core/src/pivot/collections/adapter/ core/src/pivot/io/ wtk/src/pivot/wtk/
wtk/src/pivot/wtk/media/ wtk/src/pivot/wtk/skin/terra/
Author: gbrown
Date: Thu May 28 13:59:56 2009
New Revision: 779607
URL: http://svn.apache.org/viewvc?rev=779607&view=rev
Log:
Javadoc cleanup for 1.2 release.
Added:
incubator/pivot/trunk/charts/src/pivot/charts/skin/package.html
Modified:
incubator/pivot/trunk/core/src/pivot/collections/EnumList.java
incubator/pivot/trunk/core/src/pivot/collections/EnumSet.java
incubator/pivot/trunk/core/src/pivot/collections/adapter/package.html
incubator/pivot/trunk/core/src/pivot/io/Folder.java
incubator/pivot/trunk/wtk/src/pivot/wtk/ActivityIndicatorListener.java
incubator/pivot/trunk/wtk/src/pivot/wtk/media/Image.java
incubator/pivot/trunk/wtk/src/pivot/wtk/media/Movie.java
incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/FadeWindowTransition.java
incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/TerraActivityIndicatorSkin.java
Added: incubator/pivot/trunk/charts/src/pivot/charts/skin/package.html
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/charts/src/pivot/charts/skin/package.html?rev=779607&view=auto
==============================================================================
--- incubator/pivot/trunk/charts/src/pivot/charts/skin/package.html (added)
+++ incubator/pivot/trunk/charts/src/pivot/charts/skin/package.html Thu May 28 13:59:56 2009
@@ -0,0 +1,23 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to you under the Apache License,
+Version 2.0 (the "License"); you may not use this file except in
+compliance with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<html>
+<head></head>
+<body>
+<p>Contains abstract base classes for chart view skins.</p>
+</body>
+</html>
Modified: incubator/pivot/trunk/core/src/pivot/collections/EnumList.java
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/core/src/pivot/collections/EnumList.java?rev=779607&r1=779606&r2=779607&view=diff
==============================================================================
--- incubator/pivot/trunk/core/src/pivot/collections/EnumList.java (original)
+++ incubator/pivot/trunk/core/src/pivot/collections/EnumList.java Thu May 28 13:59:56 2009
@@ -28,8 +28,8 @@
import pivot.util.ListenerList;
/**
- * Exposes enumeration values as a <tt>List</tt>, allowing callers to use
- * <tt>enum</tt>s as their data models.
+ * Implementation of the {@link List} interface that is backed by an
+ * <tt>enum</tt>.
*
* @author tvolkert
*/
Modified: incubator/pivot/trunk/core/src/pivot/collections/EnumSet.java
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/core/src/pivot/collections/EnumSet.java?rev=779607&r1=779606&r2=779607&view=diff
==============================================================================
--- incubator/pivot/trunk/core/src/pivot/collections/EnumSet.java (original)
+++ incubator/pivot/trunk/core/src/pivot/collections/EnumSet.java Thu May 28 13:59:56 2009
@@ -24,7 +24,7 @@
/**
* Implementation of the {@link Set} interface that is backed by a bitfield
- * representing enum values. Enum values are mapped to the bitfield by their
+ * representing <tt>enum</tt> values. Values are mapped to the bitfield by their
* ordinal value.
*/
public class EnumSet<E extends Enum<E>> implements Set<E>, Serializable {
Modified: incubator/pivot/trunk/core/src/pivot/collections/adapter/package.html
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/core/src/pivot/collections/adapter/package.html?rev=779607&r1=779606&r2=779607&view=diff
==============================================================================
--- incubator/pivot/trunk/core/src/pivot/collections/adapter/package.html (original)
+++ incubator/pivot/trunk/core/src/pivot/collections/adapter/package.html Thu May 28 13:59:56 2009
@@ -18,6 +18,7 @@
<html>
<head></head>
<body>
-<p>Provides a set of collection implementations that are backed by java.util collections.</p>
+<p>Provides a set of collection implementations that are backed by
+<tt>java.util</tt> collections.</p>
</body>
</html>
Modified: incubator/pivot/trunk/core/src/pivot/io/Folder.java
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/core/src/pivot/io/Folder.java?rev=779607&r1=779606&r2=779607&view=diff
==============================================================================
--- incubator/pivot/trunk/core/src/pivot/io/Folder.java (original)
+++ incubator/pivot/trunk/core/src/pivot/io/Folder.java Thu May 28 13:59:56 2009
@@ -39,6 +39,11 @@
* @author gbrown
*/
public class Folder extends File implements List<File> {
+ /**
+ * Default file name comparator.
+ *
+ * @author gbrown
+ */
public static class FileNameComparator implements Comparator<File> {
public int compare(File file1, File file2) {
String path1 = file1.getPath();
Modified: incubator/pivot/trunk/wtk/src/pivot/wtk/ActivityIndicatorListener.java
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/wtk/src/pivot/wtk/ActivityIndicatorListener.java?rev=779607&r1=779606&r2=779607&view=diff
==============================================================================
--- incubator/pivot/trunk/wtk/src/pivot/wtk/ActivityIndicatorListener.java (original)
+++ incubator/pivot/trunk/wtk/src/pivot/wtk/ActivityIndicatorListener.java Thu May 28 13:59:56 2009
@@ -16,6 +16,11 @@
*/
package pivot.wtk;
+/**
+ * Activity indicator listener interface.
+ *
+ * @author gbrown
+ */
public interface ActivityIndicatorListener {
/**
* Called when an activity indicator's active state has changed.
Modified: incubator/pivot/trunk/wtk/src/pivot/wtk/media/Image.java
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/wtk/src/pivot/wtk/media/Image.java?rev=779607&r1=779606&r2=779607&view=diff
==============================================================================
--- incubator/pivot/trunk/wtk/src/pivot/wtk/media/Image.java (original)
+++ incubator/pivot/trunk/wtk/src/pivot/wtk/media/Image.java Thu May 28 13:59:56 2009
@@ -37,7 +37,12 @@
* @author gbrown
*/
public abstract class Image implements Visual {
- protected class ImageListenerList extends ListenerList<ImageListener>
+ /**
+ * Image listener list.
+ *
+ * @author gbrown
+ */
+ protected static class ImageListenerList extends ListenerList<ImageListener>
implements ImageListener {
public void sizeChanged(Image image, int previousWidth, int previousHeight) {
for (ImageListener listener : this) {
Modified: incubator/pivot/trunk/wtk/src/pivot/wtk/media/Movie.java
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/wtk/src/pivot/wtk/media/Movie.java?rev=779607&r1=779606&r2=779607&view=diff
==============================================================================
--- incubator/pivot/trunk/wtk/src/pivot/wtk/media/Movie.java (original)
+++ incubator/pivot/trunk/wtk/src/pivot/wtk/media/Movie.java Thu May 28 13:59:56 2009
@@ -28,6 +28,11 @@
* @author tvolkert
*/
public abstract class Movie implements Visual {
+ /**
+ * Movie listener list.
+ *
+ * @author tvolkert
+ */
protected static class MovieListenerList extends ListenerList<MovieListener>
implements MovieListener {
public void sizeChanged(Movie movie, int previousWidth, int previousHeight) {
Modified: incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/FadeWindowTransition.java
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/FadeWindowTransition.java?rev=779607&r1=779606&r2=779607&view=diff
==============================================================================
--- incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/FadeWindowTransition.java (original)
+++ incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/FadeWindowTransition.java Thu May 28 13:59:56 2009
@@ -21,6 +21,11 @@
import pivot.wtk.effects.DropShadowDecorator;
import pivot.wtk.effects.FadeTransition;
+/**
+ * Transition for fading a window, including the drop shadow.
+ *
+ * @author gbrown
+ */
public class FadeWindowTransition extends FadeTransition {
private DropShadowDecorator dropShadowDecorator;
Modified: incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/TerraActivityIndicatorSkin.java
URL: http://svn.apache.org/viewvc/incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/TerraActivityIndicatorSkin.java?rev=779607&r1=779606&r2=779607&view=diff
==============================================================================
--- incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/TerraActivityIndicatorSkin.java (original)
+++ incubator/pivot/trunk/wtk/src/pivot/wtk/skin/terra/TerraActivityIndicatorSkin.java Thu May 28 13:59:56 2009
@@ -25,6 +25,11 @@
import pivot.wtk.Theme;
import pivot.wtk.skin.ActivityIndicatorSkin;
+/**
+ * Activity indicator skin.
+ *
+ * @author gbrown
+ */
public class TerraActivityIndicatorSkin extends ActivityIndicatorSkin {
private Color[] colors;
private Color backgroundColor;