Changeset 65333 in vbox for trunk/src/VBox/Frontends

Timestamp:

Jan 16, 2017 1:57:25 PM (8 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:6899: Accessibility support (step 177): A bit of care for UIInformationModel: Doxy/comments.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/runtime/information

Files:

• UIInformationModel.cpp (modified) (3 diffs)
• UIInformationModel.h (modified) (3 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/runtime/information/UIInformationModel.cpp

@@ -37 +37 @@
 #endif /* !VBOX_WITH_PRECOMPILED_HEADERS */
 
+
 UIInformationModel::UIInformationModel(QObject *pParent, const CMachine &machine, const CConsole &console)
     : QAbstractListModel(pParent)
@@ -42 +43 @@
     , m_console(console)
 {
-    /* Prepare information-model: */
+    /* Prepare: */
     prepare();
 }
@@ -112 +113 @@
 void UIInformationModel::updateData(UIInformationDataItem *pItem)
 {
-    /* Updates data: */
+    /* Update data: */
     AssertPtrReturnVoid(pItem);
     int iRow = m_list.indexOf(pItem);

trunk/src/VBox/Frontends/VirtualBox/src/runtime/information/UIInformationModel.h

@@ -45 +45 @@
 class UIInformationDataItem;
 
+
 /** QAbstractListModel extension
   * providing GUI with information-model for view in session-information window. */
@@ -53 +54 @@
 public:
 
-    /** Constructs information-model passing @a pParent to base-class.
-      * @param machine is machine reference.
-      * @param console is machine console reference. */
+    /** Constructs information-model passing @a pParent to the base-class.
+      * @param  machine  Brings the machine reference.
+      * @param  console  Brings the machine console reference. */
     UIInformationModel(QObject *pParent, const CMachine &machine, const CConsole &console);
-
     /** Destructs information-model. */
     ~UIInformationModel();
 
-    /** Returns the row-count for item specified by @a parentIdx. */
+    /** Returns the row-count for item specified by the @a parentIdx. */
     int rowCount(const QModelIndex &parentIdx = QModelIndex()) const;
 
-    /** Returns data for item specified by @a idx for the @a role. */
+    /** Returns the data for item specified by the @a index and the @a role. */
     QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) const;
 
-    /** Adds the item. */
+    /** Adds the @a pItem into the model. */
     void addItem(UIInformationDataItem *pItem);
 
-    /** Updates Data. */
+    /** Updates the data for item specified by the @a index. */
     void updateData(const QModelIndex &idx);
 
 public slots:
+
+    /** Updates the data for the specified @a pItem. */
     void updateData(UIInformationDataItem *pItem);
 
 private:
 
-    /** Prepares information-model. */
+    /** Prepares all. */
     void prepare();
 
@@ -84 +86 @@
     QHash<int, QByteArray> roleNames() const;
 
-    /** Holds the machine instance. */
+    /** Holds the machine reference. */
     CMachine m_machine;
-    /** Holds the console instance. */
+    /** Holds the machine console reference. */
     CConsole m_console;
     /** Holds the list of instances of information-data items. */