[Uml-devel] kdesdk/umbrello/umbrello

[Jonathan Riddell]

CVS commit by jriddell: 

added some comments for methods for the artifacts that I'd missed out


  M +13 -2     artifact.h   1.2
  M +23 -2     artifactwidget.h   1.2


--- kdesdk/umbrello/umbrello/artifact.h  #1.1:1.2
@@ -17,5 +17,7 @@ class IDChangeLog;
 class UMLAssociation;
 
-//FIXMEnow doc
+/**
+ * Artifacts can be drawn using one of several icons
+ */
 enum Artifact_draw_type {
         defaultDraw,
@@ -77,11 +79,20 @@ public:
         bool loadFromXMI( QDomElement & element );
 
-        //FIXMEnow doc
+        /**
+         * sets m_drawAsType for which method to draw the artifact as
+         */
         void setDrawAsType(Artifact_draw_type type);
 
+        /**
+         * returns the value of m_drawAsType
+         */
         Artifact_draw_type getDrawAsType();
 
 private:
 
+        /**
+         * Artifacts can be drawn as one of several different icons.
+         * This value choosing how to draw them.
+         */
         Artifact_draw_type m_drawAsType;
 };

--- kdesdk/umbrello/umbrello/artifactwidget.h  #1.1:1.2
@@ -78,12 +78,33 @@ private:
          */
         void calculateSize();
-        //FIXMEnow doc
+
+        /**
+         * calculates and sets the size when drawing as an icon (it's the same size for all icons)
+         */
         QSize calculateIconSize();
+
+        /**
+         * calculates and sets the size for drawing as a box
+         */
         QSize calculateNormalSize();
 
-        //FIXMEnow
+        /**
+         * draw as a file icon
+         */
         void drawAsFile(QPainter& p, int offsetX, int offsetY);
+
+        /**
+         * draw as a library file icon
+         */
         void drawAsLibrary(QPainter& p, int offsetX, int offsetY);
+
+        /**
+         * draw as a database table icon
+         */
         void drawAsTable(QPainter& p, int offsetX, int offsetY);
+
+        /**
+         * draw as a box
+         */
         void drawAsNormal(QPainter& p, int offsetX, int offsetY);