[Uml-devel] kdesdk/umbrello/umbrello

[Sebastian Stein]

CVS commit by sstein: 

changed some class documentation comments (typos fixed) - by Oliver Kellogg


  M +9 -7      codegenerator.h   1.6


--- kdesdk/umbrello/umbrello/codegenerator.h  #1.5:1.6
@@ -30,7 +30,7 @@ class UMLClass;
 
 /**
- * CodeGenerator is the basis class for all CodeGenerators. It
- * provides the Interface trough wich all Generators are invoked and
- * the all the basicfunctionality. The only thing it doesnt do is to
+ * CodeGenerator is the base class for all CodeGenerators. It
+ * provides the interface through which all Generators are invoked and
+ * the all the basic functionality. The only thing it doesn't do is to
  * generate code =)
  *
@@ -203,6 +203,6 @@ protected:
 
         /**
-         * Maps UMLObjects to filenames. Used to know to which file
-         * each class was written to.  this is useful in varios places
+         * Maps UMLObjects to filenames. Used for finding out which file
+         * each class was written to.
          */
         QMap<UMLClassifier*,QString> *m_fileMap;
@@ -210,6 +210,8 @@ protected:
 signals:
         /**
-         * This signal is emited when code for UMLClassifier c has been 
-         * successfully or unsuccessfully generated
+         * This signal is emitted when code for a UMLClassifier has been 
+         * generated.
+         * @param concept    The concept which was processed
+         * @param generated  Flag, set to true if generation was successfull
          */
         void codeGenerated(UMLClassifier* concept, bool generated);