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

[Andi Fischer]

SVN commit 945536 by fischer:

Some comments fixed reported by Krazy. Should be the last one for the moment ;-)

 M  +16 -4     diagramprintpage.cpp  
 M  +1 -1      diagramprintpage.h  


--- trunk/KDE/kdesdk/umbrello/umbrello/dialogs/diagramprintpage.cpp #945535:945536
@@ -36,7 +36,7 @@
  *  @param parent The parent to the page.
  *  @param doc    The @ref UMLDoc class instance being used.
  */
-DiagramPrintPage::DiagramPrintPage(QWidget * parent, UMLDoc * m_pDoc) : QWidget(parent), m_pDoc(m_pDoc)
+DiagramPrintPage::DiagramPrintPage(QWidget * parent, UMLDoc * doc) : QWidget(parent), m_pDoc(doc)
 {
     int margin = fontMetrics().height();
     setWindowTitle(i18n("&Diagrams"));
@@ -103,14 +103,15 @@
 }
 
 /**
- *  Standard destructor.
+ * Standard destructor.
  */
 DiagramPrintPage::~DiagramPrintPage()
 {
 }
 
 /**
- * Get selected print options
+ * Get selected print options.
+ * @return number of selected items
  */
 int DiagramPrintPage::printUmlCount()
 {
@@ -118,6 +119,11 @@
     return selectedItems.count();
 }
 
+/**
+ * Return ID string of UML diagram.
+ * @param sel   index of selected item
+ * @return      ID as string or empty string
+ */
 QString DiagramPrintPage::printUmlDiagram(int sel)
 {
     int count = 0;
@@ -138,7 +144,7 @@
 /**
  * Overridden method.
  */
-bool DiagramPrintPage::isValid( QString& msg )
+bool DiagramPrintPage::isValid(QString& msg)
 {
     int listCount = m_pSelectLW->count();
     bool sel = false;
@@ -152,6 +158,11 @@
     return sel;
 }
 
+/**
+ * Check if item with given index is selected.
+ * @param index   index of selected item
+ * @return flag whether item is selected
+ */
 bool DiagramPrintPage::isSelected(int index)
 {
     QList<QListWidgetItem *> selectedItems = m_pSelectLW->selectedItems();
@@ -224,6 +235,7 @@
 /**
  * Gets called when the user chooses another diagram type. Only diagrams of
  * this type will be shown in the diagram box.
+ * @param index   diagram type (combo box index)
  */
 void DiagramPrintPage::slotActivated(int index)
 {
--- trunk/KDE/kdesdk/umbrello/umbrello/dialogs/diagramprintpage.h #945535:945536
@@ -43,7 +43,7 @@
     int printUmlCount();
     QString printUmlDiagram(int sel);
 
-    bool isValid( QString& msg );
+    bool isValid(QString& msg);
 
 private:
     bool isSelected(int index);