Changeset 50697 in vbox

Timestamp:

Mar 5, 2014 11:21:06 AM (11 years ago)

Author:

vboxsync

Message:

FE/Qt: Medium Manager rework/cleanup: Few comments.

File:

• trunk/src/VBox/Frontends/VirtualBox/src/medium/UIMediumManager.cpp (modified) (7 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/medium/UIMediumManager.cpp

@@ -54 +54 @@
 
 
-/* Medium-item: */
+/** QTreeWidgetItem extension representing Medium Manager item. */
 class UIMediumItem : public QTreeWidgetItem
 {
 public:
 
-    /* Medium-item type: */
+    /** UIMediumItem type for rtti needs. */
     enum { Type = QTreeWidgetItem::UserType + 1 };
 
-    /* Constructor: Top-level item: */
+    /** Constructor for top-level item. */
     UIMediumItem(const UIMedium &medium, QTreeWidget *pParent)
         : QTreeWidgetItem(pParent, Type)
@@ -68 +68 @@
     { refresh(); }
 
-    /* Constructor: Child item: */
+    /** Constructor for child item. */
     UIMediumItem(const UIMedium &medium, UIMediumItem *pParent)
         : QTreeWidgetItem(pParent, Type)
@@ -74 +74 @@
     { refresh(); }
 
-    /* API: Refresh stuff: */
+    /** Refreshes item fully. */
     void refreshAll()
     {
@@ -81 +81 @@
     }
 
-    /* API: Medium stuff: */
+    /** Returns UIMedium wrapped by <i>this</i> item. */
     const UIMedium& medium() const { return m_medium; }
+    /** Defines UIMedium wrapped by <i>this</i> item. */
     void setMedium(const UIMedium &medium)
     {
@@ -89 +90 @@
     }
 
-    /* API: Medium-type stuff: */
+    /** Returns UIMediumType of the wrapped UIMedium. */
     UIMediumType mediumType() const { return m_medium.type(); }
 
-    /* API: State stuff: */
+    /** Returns KMediumState of the wrapped UIMedium. */
     KMediumState state() const { return m_medium.state(); }
 
-    /* API: ID stuff: */
+    /** Returns QString <i>ID</i> of the wrapped UIMedium. */
     QString id() const { return m_medium.id(); }
 
-    /* API: Location stuff: */
+    /** Returns QString <i>location</i> of the wrapped UIMedium. */
     QString location() const { return m_medium.location(); }
 
-    /* API: Hard-disk stuff: */
+    /** Returns QString <i>hard-disk format</i> of the wrapped UIMedium. */
     QString hardDiskFormat() const { return m_medium.hardDiskFormat(); }
+    /** Returns QString <i>hard-disk type</i> of the wrapped UIMedium. */
     QString hardDiskType() const { return m_medium.hardDiskType(); }
 
-    /* API: Details stuff: */
+    /** Returns QString <i>storage details</i> of the wrapped UIMedium. */
     QString details() const { return m_medium.storageDetails(); }
 
-    /* API: Tool-tip stuff: */
+    /** Returns QString <i>tool-tip</i> of the wrapped UIMedium. */
     QString toolTip() const { return m_medium.toolTip(); }
 
-    /* API: Usage stuff: */
+    /** Returns QString <i>usage</i> of the wrapped UIMedium. */
     QString usage() const { return m_medium.usage(); }
+    /** Returns whether wrapped UIMedium is used or not. */
     bool isUsed() const { return m_medium.isUsed(); }
+    /** Returns whether wrapped UIMedium is used in snapshots or not. */
     bool isUsedInSnapshots() const { return m_medium.isUsedInSnapshots(); }
 
-    /* API: Sorting stuff: */
+    /** Operator< reimplementation used for sorting purposes. */
     bool operator<(const QTreeWidgetItem &other) const
     {
@@ -127 +131 @@
 private:
 
-    /* Helper: Refresh stuff: */
+    /** Refreshes item information such as icon, text and tool-tip. */
     void refresh()
     {
@@ -141 +145 @@
     }
 
-    /* Variables: */
+    /** UIMedium wrapped by <i>this</i> item. */
     UIMedium m_medium;
 };