Revision: 822 Author: heuermh Date: Mon Oct 26 12:26:02 2009 Log: Issue 133 ; cleaning up SWT package class-level javadoc http://code.google.com/p/piccolo2d/source/detail?r=822
Modified: /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTBoundsHandle.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTCanvas.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTHandle.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTKeyEvent.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTMouseEvent.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTPath.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTRoot.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTSelectionEventHandler.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTText.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/SWTShapeManager.java /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/SWTTimer.java ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTBoundsHandle.java Fri Oct 16 12:15:32 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTBoundsHandle.java Mon Oct 26 12:26:02 2009 @@ -45,12 +45,11 @@ import edu.umd.cs.piccolox.util.PBoundsLocator; /** - * <b>PBoundsHandle</b> a handle for resizing the bounds of another node. If a + * <b>PSWTBoundsHandle</b> a handle for resizing the bounds of another node. If a * bounds handle is dragged such that the other node's width or height becomes * negative then the each drag handle's locator assciated with that other node * is "flipped" so that they are attached to and dragging a different corner of * the nodes bounds. - * <P> * * @version 1.0 * @author Jesse Grosjean ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTCanvas.java Mon Oct 19 09:11:29 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTCanvas.java Mon Oct 26 12:26:02 2009 @@ -62,11 +62,10 @@ import edu.umd.cs.piccolo.util.PStack; /** - * <b>PSWTCanvas</b> is a simple Swing component that can be used to embed - * Piccolo into a Java Swing application. Canvas's view the Piccolo scene graph + * <b>PSWTCanvas</b> is an SWT Composite that can be used to embed + * Piccolo into a SWT application. Canvases view the Piccolo scene graph * through a camera. The canvas manages screen updates coming from this camera, * and forwards swing mouse and keyboard events to the camera. - * <P> * * @version 1.0 * @author Jesse Grosjean ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTHandle.java Mon Oct 19 09:11:29 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTHandle.java Mon Oct 26 12:26:02 2009 @@ -49,9 +49,9 @@ import edu.umd.cs.piccolox.util.PNodeLocator; /** - * <b>PHandle</b> is used to modify some aspect of Piccolo when it is dragged. + * <b>PSWTHandle</b> is used to modify some aspect of Piccolo when it is dragged. * Each handle has a PLocator that it uses to automatically position itself. See - * PBoundsHandle for an example of a handle that resizes the bounds of another + * PSWTBoundsHandle for an example of a handle that resizes the bounds of another * node. * <P> * ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTKeyEvent.java Mon Oct 19 09:11:29 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTKeyEvent.java Mon Oct 26 12:26:02 2009 @@ -37,7 +37,7 @@ import org.eclipse.swt.widgets.Widget; /** - * Overridden to wrap an SWT KeyEvent as a swing KeyEvent. + * Key event overridden to wrap an SWT KeyEvent as a swing KeyEvent. * * @author Lance Good */ ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTMouseEvent.java Mon Oct 19 09:11:29 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTMouseEvent.java Mon Oct 26 12:26:02 2009 @@ -37,7 +37,7 @@ import org.eclipse.swt.widgets.Widget; /** - * Overridden to wrap an SWT MouseEvent as a Swing MouseEvent. + * Mouse event overridden to wrap an SWT MouseEvent as a Swing MouseEvent. * * @author Lance Good */ ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTPath.java Mon Oct 19 11:09:39 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTPath.java Mon Oct 26 12:26:02 2009 @@ -49,21 +49,8 @@ import edu.umd.cs.piccolo.util.PPaintContext; /** - * <b>PPath</b> is a wrapper around a java.awt.geom.GeneralPath. The setBounds - * method works by scaling the path to fit into the specified bounds. This - * normally works well, but if the specified base bounds get too small then it - * is impossible to expand the path shape again since all its numbers have - * tended to zero, so application code may need to take this into consideration. - * <P> - * One option that applications have is to call <code>startResizeBounds</code> - * before starting an interaction that may make the bounds very small, and - * calling <code>endResizeBounds</code> when this interaction is finished. When - * this is done PPath will use a copy of the original path to do the resizing so - * the numbers in the path wont loose resolution. - * <P> - * This class also provides methods for constructing common shapes using a - * general path. - * <P> + * <b>PSWTPath</b> is a wrapper around a java.awt.geom.GeneralPath, with + * workarounds for drawing shapes in SWT where necessary. * * @version 1.0 * @author Jesse Grosjean ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTRoot.java Mon Oct 19 09:11:29 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTRoot.java Mon Oct 26 12:26:02 2009 @@ -41,7 +41,6 @@ * environment. In particular it uses SWTTimers and the SWT event dispatch * thread. With the current setup only a single PSWTCanvas is expected to be * connected to a root. - * <P> * * @version 1.1 * @author Jesse Grosjean ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTSelectionEventHandler.java Mon Oct 19 09:11:29 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTSelectionEventHandler.java Mon Oct 26 12:26:02 2009 @@ -43,7 +43,7 @@ import edu.umd.cs.piccolox.event.PSelectionEventHandler; /** - * Modified to use SWT paths instead of normal paths. + * Selection event handler modified to use SWT paths instead of normal paths. * * @version 1.0 * @author Lance Good ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTText.java Fri Oct 16 08:03:40 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/PSWTText.java Mon Oct 26 12:26:02 2009 @@ -27,12 +27,6 @@ * repositioned with mouse clicks. The text object is positioned so that its * upper-left corner is at the origin, though this can be changed with the * translate methods. - * <P> - * <b>Warning:</b> Serialized and ZSerialized objects of this class will not be - * compatible with future Jazz releases. The current serialization support is - * appropriate for short term storage or RMI between applications running the - * same version of Jazz. A future release of Jazz will provide support for long - * term persistence. */ public class PSWTText extends PNode { private static final long serialVersionUID = 1L; ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/SWTShapeManager.java Mon Oct 19 11:14:19 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/SWTShapeManager.java Mon Oct 26 12:26:02 2009 @@ -38,6 +38,8 @@ import org.eclipse.swt.graphics.Rectangle; /** + * SWT shape manager. + * * @author Lance Good */ public class SWTShapeManager { ======================================= --- /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/SWTTimer.java Mon Oct 19 09:11:29 2009 +++ /piccolo2d.java/trunk/swt/src/main/java/edu/umd/cs/piccolox/swt/SWTTimer.java Mon Oct 26 12:26:02 2009 @@ -36,7 +36,7 @@ import org.eclipse.swt.widgets.Display; /** - * + * SWT timer. * * @author Lance Good */ --~--~---------~--~----~------------~-------~--~----~ Piccolo2D Developers Group: http://groups.google.com/group/piccolo2d-dev?hl=en -~----------~----~----~----~------~----~------~--~---