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

[Andi Fischer]

SVN commit 942048 by fischer:

Some comments fixed reported by Krazy.

 M  +1 -1      codeimport/nativeimportbase.cpp  
 M  +21 -1     dialogs/parmpropdlg.cpp  
 M  +2 -18     dialogs/parmpropdlg.h  
 M  +3 -3      docgenerators/xhtmlgenerator.cpp  
 M  +2 -2      docgenerators/xhtmlgenerator.h  


--- trunk/KDE/kdesdk/umbrello/umbrello/codeimport/nativeimportbase.cpp #942047:942048
@@ -250,7 +250,7 @@
  * Split the line so that a string is returned as a single element of the list.
  * When not in a string then split at white space.
  * The default implementation is suitable for C style strings and char constants.
- * @param lin   the line to split
+ * @param line   the line to split
  * @return the parts of the line
  */
 QStringList NativeImportBase::split(const QString& line)
--- trunk/KDE/kdesdk/umbrello/umbrello/dialogs/parmpropdlg.cpp #942047:942048
@@ -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,12 @@
 #include <QtGui/QComboBox>
 #include <QtGui/QRadioButton>
 
+/**
+ * Constructs a ParmPropDlg.
+ * @param parent   the parent of the dialog
+ * @param doc      
+ * @param attr     the parameter to represent
+ */
 ParmPropDlg::ParmPropDlg(QWidget * parent, UMLDoc * doc, UMLAttribute * attr)
         : KDialog(parent)
 {
@@ -155,6 +161,9 @@
     m_pNameLE->setFocus();
 }
 
+/**
+ * Standard destructor.
+ */
 ParmPropDlg::~ParmPropDlg()
 {
 }
@@ -244,6 +253,10 @@
     return pk;
 }
 
+/**
+ * Validates the fields in the dialog box.
+ * @return success state
+ */
 bool ParmPropDlg::validate()
 {
     // currently only validates whether the name is not null.
@@ -255,6 +268,10 @@
     return true;
 }
 
+/**
+ * Activated when a button is clicked
+ * @param button The button that was clicked
+ */
 void ParmPropDlg::slotButtonClicked(int button)
 {
     if ( button == KDialog::Ok ) {
@@ -265,6 +282,9 @@
     KDialog::slotButtonClicked( button );
 }
 
+/**
+ * Ok clicked slot.
+ */
 void ParmPropDlg::slotOk()
 {
     if (m_pAtt != NULL) {
--- trunk/KDE/kdesdk/umbrello/umbrello/dialogs/parmpropdlg.h #942047:942048
@@ -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>                  *
  ***************************************************************************/
 
@@ -38,19 +38,11 @@
     Q_OBJECT
 public:
 
-    /**
-     * Constructs a ParmPropDlg.
-     * @param parent   the parent of the dialog
-     * @param attr     the parameter to represent
-     */
     ParmPropDlg(QWidget * parent, UMLDoc * doc, UMLAttribute * attr);
-
-    /**
-     * Standard deconstructor.
-     */
     ~ParmPropDlg();
 
 public slots:
+
     void slotOk();
 
 protected:
@@ -77,22 +69,14 @@
 
     Uml::Parameter_Direction getParmKind();
 
-
     void insertTypesSorted(const QString& type = "");
 
     void insertStereotypesSorted(const QString& type = "");
 
-    /**
-     * Validates the fields in the dialog box.
-     */
     bool validate();
 
 protected slots:
 
-    /**
-     * Activated when a button is clicked
-     * @param button The button that was clicked
-     */
     virtual void slotButtonClicked(int button);
 
 private:
--- trunk/KDE/kdesdk/umbrello/umbrello/docgenerators/xhtmlgenerator.cpp #942047:942048
@@ -88,8 +88,7 @@
 
 /**
  * This slot is triggerd when the first part, xmi to docbook, is finished
- * @param docbookJob the job copying the docbook file to its destination.
- * Used only for error reporting.
+ * @param status   status to continue with converting
  */
 void XhtmlGenerator::slotDocbookToXhtml(bool status)
 {
@@ -119,10 +118,11 @@
 /**
  * Triggered when the copying of the HTML result file is finished.
  * Emits the signal finished().
+ * @param tmpFileName   temporary file name
  */
 void XhtmlGenerator::slotHtmlGenerated(const QString& tmpFileName)
 {
-    uDebug() << "HTML Generated"<<tmpFileName;
+    uDebug() << "HTML Generated " << tmpFileName;
     KUrl url = m_umlDoc->url();
     QString fileName = url.fileName();
     fileName.replace(QRegExp(".xmi$"),".html");
--- trunk/KDE/kdesdk/umbrello/umbrello/docgenerators/xhtmlgenerator.h #942047:942048
@@ -49,8 +49,8 @@
 
 protected slots:
 
-    void slotDocbookToXhtml(bool);
-    void slotHtmlGenerated(const QString&);
+    void slotDocbookToXhtml(bool status);
+    void slotHtmlGenerated(const QString& tmpFileName);
 
     void threadFinished();