[Uml-devel] KDE/kdesdk/umbrello/umbrello

Sharan Rao sharanrao at gmail.com
Tue Jul 3 20:57:03 UTC 2007


SVN commit 682995 by sharan:

Some API Dox fixes.



 M  +8 -3      association.h  
 M  +7 -0      codeimport/import_utils.h  
 M  +5 -5      entityattribute.h  
 M  +0 -1      foreignkeyconstraint.h  
 M  +2 -1      listpopupmenu.h  
 M  +1 -0      messagewidget.h  
 M  +1 -0      notewidget.h  
 M  +1 -0      umlcanvasobject.h  
 M  +1 -0      umldoc.h  
 M  +3 -1      umlrole.h  
 M  +2 -0      umlwidget.h  


--- trunk/KDE/kdesdk/umbrello/umbrello/association.h #682994:682995
@@ -157,14 +157,16 @@
     /**
      * Sets the UMLObject playing the given role in the association.
      *
-     * @param obj               Pointer to the UMLObject of the given role.
+     * @param obj  Pointer to the UMLObject of the given role.
+     * @param role The Uml::Role_Type played by the association
      */
     void setObject(UMLObject *obj, Uml::Role_Type role);
 
     /**
      * Sets the visibility of the given role of the UMLAssociation.
      *
-     * @param value     Visibility of role A visibility.
+     * @param value  Visibility of role.
+     * @param role   The Uml::Role_Type to which the visibility is being applied 
      */
     void setVisibility(Uml::Visibility value, Uml::Role_Type role);
 
@@ -172,6 +174,7 @@
      * Sets the changeability of the given role of the UMLAssociation.
      *
      * @param value     Changeability_Type of the given role.
+     * @param role      The Uml::Role_Type to which the changeability is being set
      */
     void setChangeability(Uml::Changeability_Type value, Uml::Role_Type role);
 
@@ -179,6 +182,7 @@
      * Sets the multiplicity of the given role of the UMLAssociation.
      *
      * @param multi    The multiplicity of the given role.
+     * @param role     The Uml::Role_Type to which the multiplicity is being applied
      */
     void setMulti(const QString &multi, Uml::Role_Type role);
 
@@ -193,7 +197,8 @@
     /**
      * Sets the documentation on the given role in the association.
      *
-     * @param doc               The string with the documentation.
+     * @param doc      The string with the documentation.
+     * @param role     The Uml::Role_Type to which the documentation is being applied         
      */
     void setRoleDoc(const QString &doc, Uml::Role_Type role);
 
--- trunk/KDE/kdesdk/umbrello/umbrello/codeimport/import_utils.h #682994:682995
@@ -100,6 +100,13 @@
      *               already exists  at the classifier then the incoming
      *               UMLOperation is deleted and the pointer is set to the
      *               existing UMLOperation.
+     * @param scope  The Uml::Visibility of the method
+     * @param type   The return type
+     * @param isStatic boolean switch to decide if method is static
+     * @param isAbstract boolean switch to decide if method is abstract
+     * @param isFriend true boolean switch to decide if methods is a friend function
+     * @param isConstructor boolean switch to decide if methods is a constructor
+     * @param comment The Documentation for this method
      */
     void insertMethod(UMLClassifier *klass, UMLOperation* &op,
                       Uml::Visibility scope, const QString& type,
--- trunk/KDE/kdesdk/umbrello/umbrello/entityattribute.h #682994:682995
@@ -79,7 +79,7 @@
     /**
      * Sets the initial value of the UMLEntityAttribute's attributes property.
      *
-     * @param iv  The initial value of the UMLEntityAttribute's attributes property.
+     * @param attributes  The initial value of the UMLEntityAttribute's attributes property.
      */
     void setAttributes(const QString& attributes);
 
@@ -93,7 +93,7 @@
      /** 
       * Sets the initial value of the UMLEntityAttribute's index type property. 
       * 
-      * @param iv  The initial value of the UMLEntityAttribute's index type property. 
+      * @param indexType  The initial value of the UMLEntityAttribute's index type property. 
       */ 
      void setIndexType(const Uml::DBIndex_Type indexType); 
 
@@ -107,7 +107,7 @@
     /**
      * Sets the initial value of the UMLEntityAttribute's length/values property.
      *
-     * @param iv        The initial value of the UMLEntityAttribute's length/values property.
+     * @param values        The initial value of the UMLEntityAttribute's length/values property.
      */
     void setValues(const QString& values);
 
@@ -121,7 +121,7 @@
     /**
      * Sets the initial value of the UMLEntityAttribute's auto_increment boolean
      *
-     * @param iv        The initial value of the UMLEntityAttribute's auto_increment boolean
+     * @param autoIncrement        The initial value of the UMLEntityAttribute's auto_increment boolean
      */
     void setAutoIncrement(const bool autoIncrement);
 
@@ -135,7 +135,7 @@
     /**
      * Sets the initial value of the UMLEntityAttribute's allow null value.
      *
-     * @param iv        The initial value of the UMLEntityAttribute's allow null value.
+     * @param null        The initial value of the UMLEntityAttribute's allow null value.
      */
     void setNull(const bool null);
 
--- trunk/KDE/kdesdk/umbrello/umbrello/foreignkeyconstraint.h #682994:682995
@@ -49,7 +49,6 @@
      * @param parent    The parent of this UMLForeignKeyConstraint.
      * @param name      The name of this UMLForeignKeyConstraint.
      * @param id        The unique id given to this UMLForeignKeyConstraint.
-     * @param type      The type of this UMLForeignKeyConstraint.
      */
     UMLForeignKeyConstraint(const UMLObject *parent, const QString& name,
 			    Uml::IDType id = Uml::id_None );
--- trunk/KDE/kdesdk/umbrello/umbrello/listpopupmenu.h #682994:682995
@@ -202,7 +202,8 @@
      * Constructs the popup menu for a diagram
      *
      * @param parent    The parent to ListPopupMenu.
-     * @param type              The type of menu to display.
+     * @param type      The type of menu to display.
+     * @param view      The UMLView in which this ListPopupMenu is going to be displayed
      */
     explicit ListPopupMenu(QWidget* parent, Menu_Type type = mt_Undefined, UMLView* view = 0);
 
--- trunk/KDE/kdesdk/umbrello/umbrello/messagewidget.h #682994:682995
@@ -66,6 +66,7 @@
      * Constructs a MessageWidget.
      *
      * @param view              The parent to this class.
+     * @param sequenceMessageType The Uml::Sequence_Message_Type of this message widget
      * @param id                The ID to assign (-1 will prompt a new ID.)
      */
     MessageWidget(UMLView * view, Uml::Sequence_Message_Type sequenceMessageType, Uml::IDType id = Uml::id_None);
--- trunk/KDE/kdesdk/umbrello/umbrello/notewidget.h #682994:682995
@@ -49,6 +49,7 @@
      * Constructs a NoteWidget.
      *
      * @param view              The parent to this widget.
+     * @param noteType          The NoteWidget::NoteType of this NoteWidget
      * @param id                The unique id of the widget.
      *                  The default (-1) will prompt a new ID.
      */
--- trunk/KDE/kdesdk/umbrello/umbrello/umlcanvasobject.h #682994:682995
@@ -174,6 +174,7 @@
      * Find an association.
      *
      * @param id        The id of the object to find.
+     * @param considerAncestors boolean switch to consider ancestors while searching
      * @return  Pointer to the object found (NULL if not found.)
      */
     virtual UMLObject *findChildObjectById(Uml::IDType id, bool considerAncestors = false);
--- trunk/KDE/kdesdk/umbrello/umbrello/umldoc.h #682994:682995
@@ -201,6 +201,7 @@
       * Returns true if the given name is unique within its scope of given package.
       *
       * @param name          The name to check.
+      * @package     The UMLPackage in which we have to determine the unique-ness
       * @return      True if name is unique.
       */
     bool isUnique(const QString &name, UMLPackage *package);
--- trunk/KDE/kdesdk/umbrello/umbrello/umlrole.h #682994:682995
@@ -29,7 +29,9 @@
     /**
      * Sets up an association.
      *
-     * @param parent    The parent of this UMLRole.
+     * @param parent    The parent (association) of this UMLRole.
+     * @param parentUMLObject The Parent UML Object of this UMLRole
+     * @param role  The Uml::Role_Type of this UMLRole 
      */
     UMLRole (UMLAssociation * parent, UMLObject * parentUMLObject, Uml::Role_Type role);
 
--- trunk/KDE/kdesdk/umbrello/umbrello/umlwidget.h #682994:682995
@@ -53,6 +53,7 @@
      *
      * @param view The view to be displayed on.
      * @param o The UMLObject to represent.
+     * @param widgetController The UMLWidgetController of this UMLWidget
      */
     UMLWidget( UMLView * view, UMLObject * o, UMLWidgetController *widgetController = 0 );
 
@@ -62,6 +63,7 @@
      * @param view The view to be displayed on.
      * @param id The id of the widget.
      *  The default value (id_None) will prompt generation of a new ID.
+     * @param widgetController The UMLWidgetController of this UMLWidget
      */
     explicit UMLWidget( UMLView * view, Uml::IDType id = Uml::id_None, UMLWidgetController *widgetController = 0 );
 




More information about the umbrello-devel mailing list