am 5837c3cc: ADT: Tag classes with "@since GLE1"

Merge commit '5837c3cc34e1408781479ea1c4d77260de288647'

* commit '5837c3cc34e1408781479ea1c4d77260de288647':
  ADT: Tag classes with "@since GLE1"
This commit is contained in:
Raphael
2009-08-25 16:16:17 -07:00
committed by Android Git Automerger
20 changed files with 186 additions and 146 deletions

View File

@@ -30,7 +30,9 @@ import org.eclipse.ui.PartInitException;
import org.eclipse.ui.part.EditorPart; import org.eclipse.ui.part.EditorPart;
/** /**
* Graphical layout editor, version 2. * Graphical layout editor part, version 2.
*
* @since GLE2
*/ */
public class GLE2 extends EditorPart implements IGraphicalLayoutEditor { public class GLE2 extends EditorPart implements IGraphicalLayoutEditor {

View File

@@ -111,6 +111,8 @@ import java.util.Map;
* To understand GEF: http://www.ibm.com/developerworks/opensource/library/os-gef/ * To understand GEF: http://www.ibm.com/developerworks/opensource/library/os-gef/
* <p/> * <p/>
* To understand Drag'n'drop: http://www.eclipse.org/articles/Article-Workbench-DND/drag_drop.html * To understand Drag'n'drop: http://www.eclipse.org/articles/Article-Workbench-DND/drag_drop.html
*
* @since GLE1
*/ */
public class GraphicalLayoutEditor extends GraphicalEditorWithPalette public class GraphicalLayoutEditor extends GraphicalEditorWithPalette
implements IGraphicalLayoutEditor, IConfigListener { implements IGraphicalLayoutEditor, IConfigListener {

View File

@@ -28,6 +28,8 @@ import org.eclipse.ui.IEditorPart;
/** /**
* Interface defining what {@link LayoutEditor} expects from a GraphicalLayoutEditor part. * Interface defining what {@link LayoutEditor} expects from a GraphicalLayoutEditor part.
*
* @since GLE2
*/ */
/*package*/ interface IGraphicalLayoutEditor extends IEditorPart, ILayoutReloadListener { /*package*/ interface IGraphicalLayoutEditor extends IEditorPart, ILayoutReloadListener {

View File

@@ -28,6 +28,8 @@ import java.util.List;
/** /**
* Factory that creates the palette for the {@link GraphicalLayoutEditor}. * Factory that creates the palette for the {@link GraphicalLayoutEditor}.
*
* @since GLE1
*/ */
public class PaletteFactory { public class PaletteFactory {

View File

@@ -67,6 +67,8 @@ import java.util.List;
/** /**
* Implementation of the {@link ContentOutlinePage} to display {@link UiElementNode}. * Implementation of the {@link ContentOutlinePage} to display {@link UiElementNode}.
*
* @since GLE1
*/ */
class UiContentOutlinePage extends ContentOutlinePage { class UiContentOutlinePage extends ContentOutlinePage {

View File

@@ -35,6 +35,8 @@ import org.eclipse.ui.views.properties.PropertySheetPage;
* A customized property sheet page for the graphical layout editor. * A customized property sheet page for the graphical layout editor.
* <p/> * <p/>
* Currently it just provides a custom tooltip to display attributes javadocs. * Currently it just provides a custom tooltip to display attributes javadocs.
*
* @since GLE1
*/ */
public class UiPropertySheetPage extends PropertySheetPage { public class UiPropertySheetPage extends PropertySheetPage {

View File

@@ -35,6 +35,8 @@ import java.util.Map.Entry;
* This class uses some temporary static storage to avoid excessive allocations during * This class uses some temporary static storage to avoid excessive allocations during
* drop operations. It is expected to only be invoked from the main UI thread with no * drop operations. It is expected to only be invoked from the main UI thread with no
* concurrent access. * concurrent access.
*
* @since GLE1
*/ */
class DropFeedback { class DropFeedback {

View File

@@ -29,6 +29,8 @@ import org.eclipse.gef.commands.Command;
/** /**
* A command that knows how to instantiate a new element based on a given {@link ElementDescriptor}, * A command that knows how to instantiate a new element based on a given {@link ElementDescriptor},
* the parent {@link UiElementEditPart} and an optional target location. * the parent {@link UiElementEditPart} and an optional target location.
*
* @since GLE1
*/ */
public class ElementCreateCommand extends Command { public class ElementCreateCommand extends Command {

View File

@@ -27,6 +27,8 @@ import org.eclipse.swt.SWT;
* The figure used to draw basic elements. * The figure used to draw basic elements.
* <p/> * <p/>
* The figure is totally empty and transparent except for the selection border. * The figure is totally empty and transparent except for the selection border.
*
* @since GLE1
*/ */
class ElementFigure extends Figure { class ElementFigure extends Figure {

View File

@@ -30,6 +30,8 @@ import org.eclipse.swt.SWT;
* By default the figure is transparent and empty. * By default the figure is transparent and empty.
* The base {@link ElementFigure} knows how to draw the selection border. * The base {@link ElementFigure} knows how to draw the selection border.
* This figure knows how to draw the drop feedback. * This figure knows how to draw the drop feedback.
*
* @since GLE1
*/ */
class LayoutFigure extends ElementFigure { class LayoutFigure extends ElementFigure {

View File

@@ -47,6 +47,8 @@ import java.awt.image.DataBufferInt;
* Graphical edit part for the root document. * Graphical edit part for the root document.
* <p/> * <p/>
* It acts as a simple container. * It acts as a simple container.
*
* @since GLE1
*/ */
public class UiDocumentEditPart extends UiElementEditPart { public class UiDocumentEditPart extends UiElementEditPart {

View File

@@ -22,6 +22,8 @@ import java.util.List;
/** /**
* Implementation of {@link UiElementTreeEditPart} for the document root. * Implementation of {@link UiElementTreeEditPart} for the document root.
*
* @since GLE1
*/ */
public class UiDocumentTreeEditPart extends UiElementTreeEditPart { public class UiDocumentTreeEditPart extends UiElementTreeEditPart {

View File

@@ -44,6 +44,8 @@ import java.util.List;
/** /**
* An {@link EditPart} for a {@link UiElementNode}. * An {@link EditPart} for a {@link UiElementNode}.
*
* @since GLE1
*/ */
public abstract class UiElementEditPart extends AbstractGraphicalEditPart public abstract class UiElementEditPart extends AbstractGraphicalEditPart
implements IUiUpdateListener { implements IUiUpdateListener {

View File

@@ -25,6 +25,8 @@ import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
/** /**
* Base {@link AbstractTreeEditPart} to represent {@link UiElementNode} objects in the * Base {@link AbstractTreeEditPart} to represent {@link UiElementNode} objects in the
* {@link IContentOutlinePage} linked to the layout editor. * {@link IContentOutlinePage} linked to the layout editor.
*
* @since GLE1
*/ */
public class UiElementTreeEditPart extends AbstractTreeEditPart { public class UiElementTreeEditPart extends AbstractTreeEditPart {

View File

@@ -27,6 +27,8 @@ import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
/** /**
* {@link EditPartFactory} to create {@link AbstractTreeEditPart} for {@link UiElementNode} objects. * {@link EditPartFactory} to create {@link AbstractTreeEditPart} for {@link UiElementNode} objects.
* These objects are used in the {@link IContentOutlinePage} linked to the layout editor. * These objects are used in the {@link IContentOutlinePage} linked to the layout editor.
*
* @since GLE1
*/ */
public class UiElementTreeEditPartFactory implements EditPartFactory { public class UiElementTreeEditPartFactory implements EditPartFactory {

View File

@@ -28,6 +28,8 @@ import org.eclipse.swt.widgets.Display;
* <p/> * <p/>
* The only model objects we use are {@link UiElementNode} objects and they are * The only model objects we use are {@link UiElementNode} objects and they are
* edited using {@link UiElementEditPart}. * edited using {@link UiElementEditPart}.
*
* @since GLE1
*/ */
public class UiElementsEditPartFactory implements EditPartFactory { public class UiElementsEditPartFactory implements EditPartFactory {

View File

@@ -30,6 +30,8 @@ import org.eclipse.gef.requests.CreateRequest;
* Graphical edit part for an {@link UiElementNode} that represents a ViewLayout. * Graphical edit part for an {@link UiElementNode} that represents a ViewLayout.
* <p/> * <p/>
* It acts as a simple container. * It acts as a simple container.
*
* @since GLE1
*/ */
public final class UiLayoutEditPart extends UiElementEditPart { public final class UiLayoutEditPart extends UiElementEditPart {

View File

@@ -22,6 +22,8 @@ import java.util.List;
/** /**
* Implementation of {@link UiElementTreeEditPart} for layout objects. * Implementation of {@link UiElementTreeEditPart} for layout objects.
*
* @since GLE1
*/ */
public class UiLayoutTreeEditPart extends UiElementTreeEditPart { public class UiLayoutTreeEditPart extends UiElementTreeEditPart {

View File

@@ -23,6 +23,8 @@ import org.eclipse.draw2d.XYLayout;
/** /**
* Graphical edit part for an {@link UiElementNode} that represents a View. * Graphical edit part for an {@link UiElementNode} that represents a View.
*
* @since GLE1
*/ */
public class UiViewEditPart extends UiElementEditPart { public class UiViewEditPart extends UiElementEditPart {

View File

@@ -20,6 +20,8 @@ import com.android.ide.eclipse.adt.internal.editors.uimodel.UiElementNode;
/** /**
* Implementation of {@link UiElementTreeEditPart} for view objects. * Implementation of {@link UiElementTreeEditPart} for view objects.
*
* @since GLE1
*/ */
public class UiViewTreeEditPart extends UiElementTreeEditPart { public class UiViewTreeEditPart extends UiElementTreeEditPart {