Changeset 64261 in vbox

Timestamp:

Oct 13, 2016 4:00:38 PM (8 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

111273

Message:

FE/Qt: bugref:6899: Accessibility support (step 89): Preferences: Input page: Cleanup/rework: Doxy.

File:

• trunk/src/VBox/Frontends/VirtualBox/src/settings/global/UIGlobalSettingsInput.cpp (modified) (6 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/settings/global/UIGlobalSettingsInput.cpp

@@ -53 +53 @@
 
 
-/* Global settings / Input page / Cache / Shortcut cache item: */
+/** Global settings / Input page / Cache / Shortcut cache item. */
 struct UIShortcutCacheItem
 {
+    /** Constructs table row on the basis of passed arguments.
+      * @param  strKey              Brings the unique key inentifying held sequence.
+      * @param  strDescription      Brings the deescription for the held sequence.
+      * @param  strCurrentSequence  Brings the current held sequence.
+      * @param  strDefaultSequence  Brings the default held sequence. */
     UIShortcutCacheItem(const QString &strKey,
                         const QString &strDescription,
@@ -66 +71 @@
     {}
 
+    /** Constructs table row on the basis of @a other one. */
     UIShortcutCacheItem(const UIShortcutCacheItem &other)
         : key(other.key)
@@ -73 +79 @@
     {}
 
-    UIShortcutCacheItem& operator=(const UIShortcutCacheItem &other)
-    {
+    /** Copies a table row from @a other one. */
+    UIShortcutCacheItem &operator=(const UIShortcutCacheItem &other)
+    {
+        /* Reassign variables: */
         key = other.key;
         description = other.description;
         currentSequence = other.currentSequence;
         defaultSequence = other.defaultSequence;
+
+        /* Return this: */
         return *this;
     }
 
+    /** Returns whether this row equals to @a other. */
     bool operator==(const UIShortcutCacheItem &other) const
     {
+        /* Compare by the key only: */
         return key == other.key;
     }
 
+    /** Holds the key. */
     QString key;
+    /** Holds the description. */
     QString description;
+    /** Holds the current sequence. */
     QString currentSequence;
+    /** Holds the default sequence. */
     QString defaultSequence;
 };
 
-/* Global settings / Input page / Cache / Shortcut cache: */
+
+/** Global settings / Input page / Cache / Shortcut cache. */
 typedef QList<UIShortcutCacheItem> UIShortcutCache;
 
-/* Global settings / Input page / Cache: */
+
+/** Global settings / Input page / Cache. */
 class UISettingsCacheGlobalInput : public QObject
 {
@@ -103 +121 @@
 public:
 
+    /** Constructs cache passing @a pParent to the base-class. */
     UISettingsCacheGlobalInput(QObject *pParent)
         : QObject(pParent)
@@ -108 +127 @@
     {}
 
+    /** Holds the shortcut cache. */
     UIShortcutCache m_shortcuts;
+
+    /** Holds whether the keyboard auto-capture is enabled. */
     bool m_fAutoCapture;
 };
 
 
-/* Global settings / Input page / Cache / Shortcut cache item sort functor: */
+/** Global settings / Input page / Cache / Shortcut cache item sort functor. */
 class UIShortcutCacheItemFunctor
 {
 public:
 
+    /** Constructs cache sorting functor.
+      * @param  iColumn  Brings the column sorting should be done according to.
+      * @param  m_order  Brings the sorting order to be applied. */
     UIShortcutCacheItemFunctor(int iColumn, Qt::SortOrder order)
         : m_iColumn(iColumn)
         , m_order(order)
-    {
-    }
-
+    {}
+
+    /** Returns whether the @a item1 is more/less than the @a item2.
+      * @note  Order depends on the one set through constructor, stored in m_order. */
     bool operator()(const UIShortcutCacheItem &item1, const UIShortcutCacheItem &item2)
     {
@@ -139 +165 @@
 private:
 
+    /** Holds the column sorting should be done according to. */
     int m_iColumn;
+    /** Holds the sorting order to be applied. */
     Qt::SortOrder m_order;
 };