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

[Andi Fischer]

SVN commit 941130 by fischer:

Some comments fixed reported by Krazy.

 M  +3 -2      umldoc.h  
 M  +30 -2     umlobject.cpp  
 M  +5 -34     umlobject.h  


--- trunk/KDE/kdesdk/umbrello/umbrello/umldoc.h #941129:941130
@@ -4,7 +4,7 @@
  *   the Free Software Foundation; either version 2 of the License, or     *
  *   (at your option) any later version.                                   *
  *                                                                         *
- *   copyright (C) 2002-2008                                               *
+ *   copyright (C) 2002-2009                                               *
  *   Umbrello UML Modeller Authors <uml-devel at uml.sf.net>                  *
  ***************************************************************************/
 
@@ -541,7 +541,8 @@
     /**
      * Controls the printing of the program.
      *
-     * @param pPrinter  The printer (object) to use.
+     * @param pPrinter   The printer (object) to use.
+     * @param selectPage diagram print page
      */
     void print(QPrinter * pPrinter, DiagramPrintPage * selectPage);
 
--- trunk/KDE/kdesdk/umbrello/umbrello/umlobject.cpp #941129:941130
@@ -4,7 +4,7 @@
  *   the Free Software Foundation; either version 2 of the License, or     *
  *   (at your option) any later version.                                   *
  *                                                                         *
- *   copyright (C) 2002-2008                                               *
+ *   copyright (C) 2002-2009                                               *
  *   Umbrello UML Modeller Authors <uml-devel at uml.sf.net>                  *
  ***************************************************************************/
 
@@ -35,6 +35,13 @@
 
 using namespace Uml;
 
+/**
+ * Creates a UMLObject.
+ * @param parent   The parent of the object.
+ * @param name     The name of the object.
+ * @param id       The ID of the object (optional.) If omitted
+ *                 then a new ID will be assigned internally.
+ */
 UMLObject::UMLObject(UMLObject * parent, const QString &name, Uml::IDType id)
         : QObject(parent)
 {
@@ -47,6 +54,12 @@
     m_Name = name;
 }
 
+/**
+ * Creates a UMLObject.
+ * @param name     The name of the object.
+ * @param id       The ID of the object (optional.) If omitted
+ *                 then a new ID will be assigned internally.
+ */
 UMLObject::UMLObject(const QString &name, Uml::IDType id)
         :  QObject(UMLApp::app()->getDocument())
 {
@@ -58,12 +71,19 @@
     m_Name = name;
 }
 
+/**
+ * Creates a UMLObject.
+ * @param   parent   The parent of the object.
+ */
 UMLObject::UMLObject(UMLObject * parent)
         : QObject(parent)
 {
     init();
 }
 
+/**
+ * Standard destructor.
+ */
 UMLObject::~UMLObject()
 {
 }
@@ -199,6 +219,9 @@
     return fqn;
 }
 
+/**
+ * Overloaded '==' operator
+ */
 bool UMLObject::operator==(const UMLObject & rhs)
 {
     if (this == &rhs)
@@ -419,7 +442,7 @@
  * to zero then the UMLStereotype is removed at the UMLDoc and
  * it is then physically deleted.
  *
- * @param s Sets the classes UMLStereotype.
+ * @param stereo Sets the classes UMLStereotype.
  */
 void UMLObject::setUMLStereotype(UMLStereotype *stereo)
 {
@@ -504,6 +527,11 @@
     emitModified();
 }
 
+/**
+ * Returns the classes UMLStereotype object.
+ *
+ * @return   Returns the classes UMLStereotype object.
+ */
 const UMLStereotype * UMLObject::getUMLStereotype()
 {
     return m_pStereotype;
--- trunk/KDE/kdesdk/umbrello/umbrello/umlobject.h #941129:941130
@@ -1,11 +1,10 @@
 /***************************************************************************
- *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
  *   (at your option) any later version.                                   *
  *                                                                         *
- *   copyright (C) 2002-2008                                               *
+ *   copyright (C) 2002-2009                                               *
  *   Umbrello UML Modeller Authors <uml-devel at uml.sf.net>                  *
  ***************************************************************************/
 
@@ -37,33 +36,12 @@
     Q_OBJECT
 public:
 
-    /**
-     * Creates a UMLObject.
-     *
-     * @param parent   The parent of the object.
-     * @param name     The name of the object.
-     * @param id       The ID of the object (optional.) If omitted
-     *                 then a new ID will be assigned internally.
-     */
     UMLObject(UMLObject * parent, const QString &name, Uml::IDType id = Uml::id_None);
-
-    /**
-     * Creates a UMLObject.
-     *
-     * @param   parent   The parent of the object.
-     */
     UMLObject(UMLObject * parent);
-
     explicit UMLObject(const QString &name = QString() , Uml::IDType id = Uml::id_None);
 
-    /**
-     * Overloaded '==' operator
-     */
     bool operator==(const UMLObject & rhs );
 
-    /**
-     * Standard deconstructor.
-     */
     virtual ~UMLObject();
 
     virtual void copyInto(UMLObject *lhs) const;
@@ -84,23 +62,18 @@
 
     void setVisibility(Uml::Visibility s);
 
-     void setVisibilitycmd(Uml::Visibility s);
+    void setVisibilitycmd(Uml::Visibility s);
 
     void setStereotype(const QString &_name);
 
     void setStereotypecmd(const QString &_name);
 
-    void setUMLStereotype(UMLStereotype *s);
+    void setUMLStereotype(UMLStereotype *stereo);
 
     void setPackage(const QString &_name);
 
     void setUMLPackage(UMLPackage* pPkg);
 
-    /**
-     * Returns the classes UMLStereotype object.
-     *
-     * @return   Returns the classes UMLStereotype object.
-     */
     const UMLStereotype * getUMLStereotype();
 
     QString getStereotype(bool includeAdornments = false) const;
@@ -114,19 +87,17 @@
 
     virtual void setID(Uml::IDType NewID);
 
+    virtual void setName(const QString &strName);
     QString getName() const;
 
-    virtual void setName(const QString &strName);
-
     void setNamecmd(const QString &strName) ;
 
     virtual QString getFullyQualifiedName(const QString& separator = QString(),
                                           bool includeRoot = false) const;
 
+    void setAbstract(bool bAbstract);
     bool getAbstract() const;
 
-    void setAbstract(bool bAbstract);
-
     void setInPaste(bool bInPaste = true);
 
     virtual bool showProperties(int page = 0, bool assoc = false);