[Uml-devel] kdesdk/umbrello/umbrello

[Oliver Kellogg]

CVS commit by okellogg: 

Comment cosmetics & doxygenics.


  M +36 -18    worktoolbar.h   1.16


--- kdesdk/umbrello/umbrello/worktoolbar.h  #1.15:1.16
@@ -28,11 +28,22 @@ class WorkToolBar : public KToolBar {
 public:
 
-enum EditTool {Select = 0, Generalization, Aggregation, Dependency, Association,
-CollMessage, SeqMessage, Composition, UniAssociation, StateTransition, ActivityTransition,
- Anchor, Note, Box, Text, Actor, UseCase, Class, Interface, Package, Component, Artifact, Object,
-InitialState, State, EndState, InitialActivity, Activity, EndActivity, Branch, Fork };  
+        /**
+         * Enumeration of all available edit tools.
+         */
+        enum EditTool {
+                Select = 0,
+                Generalization, Aggregation, Dependency, Association,
+                CollMessage, SeqMessage,
+                Composition, UniAssociation,
+                StateTransition, ActivityTransition,
+                Anchor, Note, Box, Text,
+                Actor, UseCase, Class, Interface,
+                Package, Component, Artifact, Object,
+                InitialState, State, EndState,
+                InitialActivity, Activity, EndActivity, Branch, Fork
+        };
 
         /**
-         *      Creates a work tool bar
+         * Creates a work tool bar.
          *
          *      @param  parentWindow    The parent of the toolbar.
@@ -42,6 +53,6 @@ InitialState, State, EndState, InitialAc
 
         /**
-         * Sets the current tool to the previously used Tool, this is just
-         * as if the user had pressed the button for the other tool
+         * Sets the current tool to the previously used Tool. This is just
+         * as if the user had pressed the button for the other tool.
          */
         void setOldTool();
@@ -49,17 +60,24 @@ InitialState, State, EndState, InitialAc
         /**
          * Sets the current tool to the default tool. (select tool)
-         * calling this function is as if the user had pressed the "arrow"
-         * button on the toolbar
+         * Calling this function is as if the user had pressed the "arrow"
+         * button on the toolbar.
          */
         void setDefaultTool();
         
+        /**
+         * Returns the currently selected EditTool.
+         *
+         * @return      The currently selected EditTool.
+         */
         EditTool currentTool();
 
         /**
-         *      Standard deconstructor
+         * Standard deconstructor.
          */
         ~WorkToolBar();
         
-
+        /**
+         * Enumeration of all available toolbar buttons.
+         */
         enum ToolBar_Buttons
         {