Author: tfmorris Date: 2008-03-27 23:32:34-0700 New Revision: 14242 Modified: trunk/src/app/src/org/argouml/cognitive/ToDoItem.java trunk/src/app/src/org/argouml/kernel/Project.java trunk/src/app/src/org/argouml/uml/reveng/ImportSettings.java trunk/src/app/src/org/argouml/uml/reveng/Setting.java trunk/src/app/src/org/argouml/uml/ui/AbstractActionAddModelElement2.java trunk/src/app/src/org/argouml/uml/ui/model_management/PropPanelPackage.java trunk/src/app/tests/org/argouml/uml/diagram/state/ui/TestFigClonable.java
Log: Improve comments Modified: trunk/src/app/src/org/argouml/cognitive/ToDoItem.java Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/src/org/argouml/cognitive/ToDoItem.java?view=diff&rev=14242&p1=trunk/src/app/src/org/argouml/cognitive/ToDoItem.java&p2=trunk/src/app/src/org/argouml/cognitive/ToDoItem.java&r1=14241&r2=14242 ============================================================================== --- trunk/src/app/src/org/argouml/cognitive/ToDoItem.java (original) +++ trunk/src/app/src/org/argouml/cognitive/ToDoItem.java 2008-03-27 23:32:34-0700 @@ -103,23 +103,22 @@ private String theMoreInfoURL; /** - * Which part of the design this issue affects.<p> - * - * Each member is either a model element, a [EMAIL PROTECTED] Fig}, or - * a [EMAIL PROTECTED] Diagram}. TODO: Because there is not a common - * supertype for these three types, we can't type this list. - * We should introduce a common supertype/interface. - tfm <p> - * - * This is set by the constructor and cannot change.<p> - * - * TODO: Offenders need to be more strongly typed. - tfm 20070630 + * The part of the design this issue affects. + * <p> + * Each member is either a model element, a [EMAIL PROTECTED] Fig}, or a + * [EMAIL PROTECTED] Diagram}. + * <p> + * TODO: Offenders need to be more strongly typed. Because there is not a + * common supertype for these three types, we can't type this list. We + * should introduce a common supertype/interface. - tfm 20070630 + * <p> + * This is set by the constructor and cannot change. + * <p> */ private ListSet theOffenders; private Wizard theWizard; - //////////////////////////////////////////////////////////////// - // constructors /** * The constructor. * Modified: trunk/src/app/src/org/argouml/kernel/Project.java Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/src/org/argouml/kernel/Project.java?view=diff&rev=14242&p1=trunk/src/app/src/org/argouml/kernel/Project.java&p2=trunk/src/app/src/org/argouml/kernel/Project.java&r1=14241&r2=14242 ============================================================================== --- trunk/src/app/src/org/argouml/kernel/Project.java (original) +++ trunk/src/app/src/org/argouml/kernel/Project.java 2008-03-27 23:32:34-0700 @@ -528,9 +528,10 @@ * * @return the Package which is the root * @deprecated for 0.25.4 by tfmorris - use [EMAIL PROTECTED] #getRoots()} to - * packages/model elements which are at the top level. TODO: We - * probably need a getDefaultNamespace() method or something - * similar to replace some uses of this. + * packages/model elements which are at the top level. + * <p> + * TODO: We probably need a getDefaultNamespace() method or + * something similar to replace some uses of this. */ @Deprecated public Object getRoot(); Modified: trunk/src/app/src/org/argouml/uml/reveng/ImportSettings.java Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/src/org/argouml/uml/reveng/ImportSettings.java?view=diff&rev=14242&p1=trunk/src/app/src/org/argouml/uml/reveng/ImportSettings.java&p2=trunk/src/app/src/org/argouml/uml/reveng/ImportSettings.java&r1=14241&r2=14242 ============================================================================== --- trunk/src/app/src/org/argouml/uml/reveng/ImportSettings.java (original) +++ trunk/src/app/src/org/argouml/uml/reveng/ImportSettings.java 2008-03-27 23:32:34-0700 @@ -72,16 +72,16 @@ public boolean isDatatypeSelected(); /** - * TODO: This should be removed when diagram updating removed from the importers - * (as it should be). - tfm 20061129 + * TODO: This should be removed when diagram updating removed from the + * importers (as it should be). - tfm 20061129 * @return true if the user has request diagrams to be created for packages * contained in the imported source code. */ public boolean isCreateDiagramsSelected(); /** - * TODO: This should be removed when diagram updating removed from the importers - * (as it should be). - tfm 20061129 + * TODO: This should be removed when diagram updating removed from the + * importers (as it should be). - tfm 20061129 * @return true, if user has requested that new figures placed in diagrams * should be minimized so they don't show internal compartments. */ Modified: trunk/src/app/src/org/argouml/uml/reveng/Setting.java Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/src/org/argouml/uml/reveng/Setting.java?view=diff&rev=14242&p1=trunk/src/app/src/org/argouml/uml/reveng/Setting.java&p2=trunk/src/app/src/org/argouml/uml/reveng/Setting.java&r1=14241&r2=14242 ============================================================================== --- trunk/src/app/src/org/argouml/uml/reveng/Setting.java (original) +++ trunk/src/app/src/org/argouml/uml/reveng/Setting.java 2008-03-27 23:32:34-0700 @@ -1,5 +1,5 @@ // $Id$ -// Copyright (c) 2006 The Regents of the University of California. All +// Copyright (c) 2006-2008 The Regents of the University of California. All // Rights Reserved. Permission to use, copy, modify, and distribute this // software and its documentation without fee, and without a written // agreement is hereby granted, provided that the above copyright notice @@ -36,6 +36,11 @@ */ private String label; + /** + * Construct a new Setting with the given label text. + * + * @param labelText string to use as the label + */ public Setting(String labelText) { super(); label = labelText; Modified: trunk/src/app/src/org/argouml/uml/ui/AbstractActionAddModelElement2.java Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/src/org/argouml/uml/ui/AbstractActionAddModelElement2.java?view=diff&rev=14242&p1=trunk/src/app/src/org/argouml/uml/ui/AbstractActionAddModelElement2.java&p2=trunk/src/app/src/org/argouml/uml/ui/AbstractActionAddModelElement2.java&r1=14241&r2=14242 ============================================================================== --- trunk/src/app/src/org/argouml/uml/ui/AbstractActionAddModelElement2.java (original) +++ trunk/src/app/src/org/argouml/uml/ui/AbstractActionAddModelElement2.java 2008-03-27 23:32:34-0700 @@ -60,18 +60,27 @@ Translator.localize("menu.popup.add-modelelement")); } + /** + * Construct a named action to add a model element to some list. + * @param name name for action + */ public AbstractActionAddModelElement2(String name) { super(name); } + /** + * Construct an action to add a model element to some list with the + * given name and icon. + * @param name name for action + * @param icon icon for action + */ public AbstractActionAddModelElement2(String name, Icon icon) { super(name, icon); } /* - * @see - * java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent) + * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent) */ @Override public void actionPerformed(ActionEvent e) { Modified: trunk/src/app/src/org/argouml/uml/ui/model_management/PropPanelPackage.java Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/src/org/argouml/uml/ui/model_management/PropPanelPackage.java?view=diff&rev=14242&p1=trunk/src/app/src/org/argouml/uml/ui/model_management/PropPanelPackage.java&p2=trunk/src/app/src/org/argouml/uml/ui/model_management/PropPanelPackage.java&r1=14241&r2=14242 ============================================================================== --- trunk/src/app/src/org/argouml/uml/ui/model_management/PropPanelPackage.java (original) +++ trunk/src/app/src/org/argouml/uml/ui/model_management/PropPanelPackage.java 2008-03-27 23:32:34-0700 @@ -208,12 +208,15 @@ /** * NOTE: This class almost, but not quite, implements the interfaces defined in - * [EMAIL PROTECTED] org.argouml.uml.ui.AbstractActionAddModelElement}. The difference is + * [EMAIL PROTECTED] org.argouml.uml.ui.AbstractActionAddModelElement2}. The difference is * that the doIt(), getChoices(), and getSelected() methods here accept an extra * argument containing the target. */ class ActionDialogElementImport extends UndoableAction { + /** + * Construct an Action which brings up the Add Element Import dialog. + */ public ActionDialogElementImport() { super(); putValue(Action.SMALL_ICON, Modified: trunk/src/app/tests/org/argouml/uml/diagram/state/ui/TestFigClonable.java Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/app/tests/org/argouml/uml/diagram/state/ui/TestFigClonable.java?view=diff&rev=14242&p1=trunk/src/app/tests/org/argouml/uml/diagram/state/ui/TestFigClonable.java&p2=trunk/src/app/tests/org/argouml/uml/diagram/state/ui/TestFigClonable.java&r1=14241&r2=14242 ============================================================================== --- trunk/src/app/tests/org/argouml/uml/diagram/state/ui/TestFigClonable.java (original) +++ trunk/src/app/tests/org/argouml/uml/diagram/state/ui/TestFigClonable.java 2008-03-27 23:32:34-0700 @@ -138,7 +138,7 @@ /** - * Try to clone [EMAIL PROTECTED] FigTransistion}. + * Try to clone [EMAIL PROTECTED] FigTransition}. */ public void testTransitionClonable() { FigTransition fig = new FigTransition(); --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
