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

[Andi Fischer]

SVN commit 917351 by fischer:

Fixing some comments.

 M  +11 -9     codedocument.cpp  
 M  +0 -15     codedocument.h  


--- trunk/KDE/kdesdk/umbrello/umbrello/codegenerators/codedocument.cpp #917350:917351
@@ -23,6 +23,9 @@
 #include "umldoc.h"
 #include "uml.h"
 
+/**
+ * Constructor.
+ */
 CodeDocument::CodeDocument () : CodeGenObjectWithTextBlocks(this),
     m_lastTagIndex(0), m_filename(QString()), m_fileExtension(QString()),
     m_ID(QString()), m_pathName(QString()), m_package(NULL), m_writeOutCode(true)  
@@ -31,6 +34,9 @@
     //  m_dialog = new CodeDocumentDialog( );
 }
 
+/**
+ * Destructor.
+ */
 CodeDocument::~CodeDocument ( )
 {
     // delete all the text blocks we have
@@ -265,10 +271,9 @@
     return CodeGenerator::cleanName(name);
 }
 
-// update the text and status of the head comment
-
 /**
- * Update the header text of this codedocument.
+ * Update the header text of this codedocument
+ * (text and status of the head comment).
  */
 void CodeDocument::updateHeader ()
 {
@@ -325,10 +330,9 @@
     updateContent();
 }
 
-// need to overload method to be able to clear the childTextBlockMap
-
 /**
  * Reset/clear our inventory of textblocks in this document.
+ * Need to overload method to be able to clear the childTextBlockMap.
  */
 void CodeDocument::resetTextBlocks()
 {
@@ -433,14 +437,12 @@
     root.appendChild( docElement );
 }
 
-// vanilla code documents don't have much
-// to do.. override this with a different
-// version for your own documents
-
 /**
  * Update the content of this code document.
  * This is where you should lay out your code document structure of textblocks
  * in the inheriting class, should it have any text in it.
+ * Vanilla code documents don't have much to do.. override this with a different
+ * version for your own documents.
  */
 void CodeDocument::updateContent()
 {
--- trunk/KDE/kdesdk/umbrello/umbrello/codegenerators/codedocument.h #917350:917351
@@ -36,32 +36,21 @@
     Q_OBJECT
 public:
 
-    /**
-     * Empty Constructor
-     */
     CodeDocument ( );
-
-    /**
-     * Empty Destructor
-     */
     virtual ~CodeDocument ( );
 
     void setFileExtension ( const QString &new_var );
-
     QString getFileExtension ( ) const;
 
     void setFileName ( const QString &new_var );
-
     QString getFileName ( ) const;
 
     void setPackage ( UMLPackage *new_var );
-
     QString getPackage ( ) const;
 
     virtual QString getPath ( );
 
     void setID ( const QString &new_id);
-
     QString getID ( ) const;
 
     void setWriteOutCode ( bool new_var );
@@ -69,7 +58,6 @@
     bool getWriteOutCode ( );
 
     void setHeader ( CodeComment * comment );
-
     CodeComment * getHeader ( );
 
     bool insertTextBlock (TextBlock * newBlock, TextBlock * existingBlock, bool after = true);
@@ -79,13 +67,10 @@
     virtual QString toString ( );
 
     virtual void saveToXMI ( QDomDocument & doc, QDomElement & root );
-
     virtual void loadFromXMI ( QDomElement & root );
 
     virtual CodeBlock * newCodeBlock ( );
-
     virtual HierarchicalCodeBlock * newHierarchicalCodeBlock ( );
-
     virtual CodeBlockWithComments * newCodeBlockWithComments ( );
 
     virtual QString getUniqueTag( const QString& prefix = QString("") );