[Uml-devel] branches/KDE/3.5/kdesdk/umbrello/umbrello
Oliver Kellogg
okellogg at users.sourceforge.net
Tue Jun 26 05:53:48 UTC 2007
SVN commit 680408 by okellogg:
further ApiDox fixes
M +2 -1 association.h
M +1 -0 associationwidget.h
M +1 -0 classifiercodedocument.h
M +1 -1 classifierwidget.h
M +1 -1 codegenerationpolicy.h
M +5 -4 codegenerator.h
M +1 -1 codegenerators/adawriter.h
M +1 -1 codegenerators/pascalwriter.h
M +18 -18 entityattribute.h
M +2 -1 linepath.h
M +0 -1 notewidget.h
M +1 -1 package.h
M +2 -2 umllistview.h
M +1 -1 umllistviewitem.h
M +3 -0 umlwidget.cpp
M +1 -3 umlwidget.h
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/association.h #680407:680408
@@ -186,7 +186,8 @@
/**
* Sets the name of the given role of the UMLAssociation.
*
- * @param roleNameA The name of the given role.
+ * @param roleName The name to set for the given role.
+ * @param role The Uml::Role_Type for which to set the name.
*/
void setRoleName(const QString &roleName, Uml::Role_Type role);
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/associationwidget.h #680407:680408
@@ -116,6 +116,7 @@
* Set the widget of the given role.
*
* @param widget Pointer to the UMLWidget.
+ * @param role Role for which to set the widget.
*/
void setWidget(UMLWidget* widget, Uml::Role_Type role);
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/classifiercodedocument.h #680407:680408
@@ -136,6 +136,7 @@
* codeclassfield object in this classifiercodedocument. Returns
* NULL if no such codeclassfield object exists in this document.
*
+ * @param id ID of the parent object
* @param role_id 0 for role A of the asssociation
* 1 for role B of the asssociation
* -1 if this is an attribute.
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/classifierwidget.h #680407:680408
@@ -227,7 +227,7 @@
* Sets whether to draw as circle.
* Only applies when m_pObject->getBaseType() is ot_Interface.
*
- * @param _show True if widget shall be drawn as circle.
+ * @param drawAsCircle True if widget shall be drawn as circle.
*/
void setDrawAsCircle(bool drawAsCircle);
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/codegenerationpolicy.h #680407:680408
@@ -251,7 +251,7 @@
/**
* Set the value of m_autoGenerateConstructors
- * @param new_var the new value
+ * @param var the new value
*/
void setAutoGenerateConstructors ( bool var );
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/codegenerator.h #680407:680408
@@ -206,10 +206,11 @@
virtual QString getHeadingFile (const QString &file );
/**
- * Finds an appropriate file name for class c, taking into account the Overwrite
- * Policy and asking the user what to do if need be. (if policy == Ask)
+ * Finds an appropriate file name for the given CodeDocument, taking into
+ * account the Overwrite Policy and asking the user what to do if need be
+ * (if policy == Ask).
*
- * @param concept the class for which an output file name is desired.
+ * @param doc the CodeDocument for which an output file name is desired.
* @return the file name that should be used. (with extension) or
* NULL if none to be used
*/
@@ -230,7 +231,7 @@
*
* @return the formatted documentation text
*/
- QString formatDoc (const QString & text, const QString & lineprefix = " *", int linewidth = 80 );
+ QString formatDoc (const QString & text, const QString & linePrefix = " *", int lineWidth = 80 );
/**
* Finds all classes in the current document to which objects of class c
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/codegenerators/adawriter.h #680407:680408
@@ -64,7 +64,7 @@
* @param rPossiblyReservedKeyword The string to check.
* @return true if the keyword is reserved
*/
- virtual bool isReservedKeyword(const QString & rPossiblyReservedKeyWord);
+ virtual bool isReservedKeyword(const QString & rPossiblyReservedKeyword);
/**
* get list of reserved keywords
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/codegenerators/pascalwriter.h #680407:680408
@@ -55,7 +55,7 @@
*
* @param rPossiblyReservedKeyword The string to check.
*/
- virtual bool isReservedKeyword(const QString & rPossiblyReservedKeyWord);
+ virtual bool isReservedKeyword(const QString & rPossiblyReservedKeyword);
/**
* get list of reserved keywords
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/entityattribute.h #680407:680408
@@ -77,65 +77,65 @@
QString getAttributes();
/**
- * Sets the initial value of the UMLEntityAttribute's attributes property.
+ * Sets the UMLEntityAttribute's attributes property.
*
- * @param iv The initial value of the UMLEntityAttribute's attributes property.
+ * @param attributes The new value for the attributes property.
*/
void setAttributes(const QString& attributes);
/**
- * Returns The initial value of the UMLEntityAttribute's index type property.
+ * Returns the UMLEntityAttribute's index type property.
*
- * @return The initial value of the UMLEntityAttribute's index type property.
+ * @return The value of the UMLEntityAttribute's index type property.
*/
Uml::DBIndex_Type getIndexType();
/**
- * Sets the initial value of the UMLEntityAttribute's index type property.
+ * Sets the UMLEntityAttribute's index type property.
*
- * @param iv The initial value of the UMLEntityAttribute's index type property.
+ * @param indexType The UMLEntityAttribute's index type property.
*/
void setIndexType(const Uml::DBIndex_Type indexType);
/**
- * Returns The initial value of the UMLEntityAttribute's length/values property.
+ * Returns the UMLEntityAttribute's length/values property.
*
- * @return The initial value of the UMLEntityAttribute's length/values property.
+ * @return The UMLEntityAttribute's length/values property.
*/
QString getValues();
/**
- * Sets the initial value of the UMLEntityAttribute's length/values property.
+ * Sets the UMLEntityAttribute's length/values property.
*
- * @param iv The initial value of the UMLEntityAttribute's length/values property.
+ * @param values The new value of the length/values property.
*/
void setValues(const QString& values);
/**
- * Returns The initial value of the UMLEntityAttribute's auto_increment boolean
+ * Returns the UMLEntityAttribute's auto_increment boolean
*
- * @return The initial value of the UMLEntityAttribute's auto_increment boolean
+ * @return The UMLEntityAttribute's auto_increment boolean
*/
bool getAutoIncrement();
/**
- * Sets the initial value of the UMLEntityAttribute's auto_increment boolean
+ * Sets the UMLEntityAttribute's auto_increment property
*
- * @param iv The initial value of the UMLEntityAttribute's auto_increment boolean
+ * @param autoIncrement The UMLEntityAttribute's auto_increment property
*/
void setAutoIncrement(const bool autoIncrement);
/**
- * Returns The initial value of the UMLEntityAttribute's allow null value.
+ * Returns the UMLEntityAttribute's allow null value.
*
- * @return The initial value of the UMLEntityAttribute's allow null value.
+ * @return The UMLEntityAttribute's allow null value.
*/
bool getNull();
/**
- * Sets the initial value of the UMLEntityAttribute's allow null value.
+ * Sets the UMLEntityAttribute's allow null value.
*
- * @param iv The initial value of the UMLEntityAttribute's allow null value.
+ * @param null The UMLEntityAttribute's allow null value.
*/
void setNull(const bool null);
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/linepath.h #680407:680408
@@ -271,7 +271,8 @@
/**
* Create a number of new lines and append them to the given list.
*
- * @param by The number of lines to insert into the given list.
+ * @param list The list into which to append lines.
+ * @param by The number of lines to insert into the given list.
*/
void growList(LineList &list, int by);
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/notewidget.h #680407:680408
@@ -41,7 +41,6 @@
* Constructs a NoteWidget.
*
* @param view The parent to this widget.
- * @param noteType The type of the widget.
* @param id The unique id of the widget.
* The default (-1) will prompt a new ID.
*/
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/package.h #680407:680408
@@ -40,7 +40,7 @@
* @param name The name of the Concept.
* @param id The unique id of the Concept.
*/
- explicit UMLPackage(const QString & Name = "", Uml::IDType id = Uml::id_None);
+ explicit UMLPackage(const QString & name = "", Uml::IDType id = Uml::id_None);
/**
* Empty deconstructor.
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/umllistview.h #680407:680408
@@ -184,7 +184,7 @@
/**
* Searches through the tree for the item which represents the diagram given
- * @param the diagram to search for
+ * @param v the diagram to search for
* @return the item which represents the diagram
*/
UMLListViewItem * findView(UMLView *v);
@@ -379,7 +379,7 @@
/**
* renames a diagram in the list view
- * @param the id of the renamed diagram
+ * @param id the id of the renamed diagram
*/
void slotDiagramRenamed(Uml::IDType id);
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/umllistviewitem.h #680407:680408
@@ -110,7 +110,7 @@
/**
* Set the UMLObject associated with this instance.
*
- * @param The object this class represents.
+ * @param obj The object this class represents.
*/
void setUMLObject(UMLObject * obj) {
m_pObject = obj;
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/umlwidget.cpp #680407:680408
@@ -938,6 +938,9 @@
return m_bShowStereotype;
}
+void UMLWidget::moveEvent(QMoveEvent *me) {
+}
+
void UMLWidget::saveToXMI( QDomDocument & qDoc, QDomElement & qElement ) {
/*
Call after required actions in child class.
--- branches/KDE/3.5/kdesdk/umbrello/umbrello/umlwidget.h #680407:680408
@@ -505,7 +505,7 @@
*
* @param me The move event.
*/
- virtual void moveEvent(QMoveEvent *) { }
+ virtual void moveEvent(QMoveEvent *me);
virtual void saveToXMI( QDomDocument & qDoc, QDomElement & qElement );
@@ -671,8 +671,6 @@
/**
* When a widget changes this slot captures that signal.
- *
- * @param o The changed UMLobject
*/
virtual void updateWidget();
More information about the umbrello-devel
mailing list