Changeset 70826 in vbox

Timestamp:

Jan 31, 2018 12:17:13 PM (7 years ago)

Author:

vboxsync

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

120631

Message:

FE/Qt: bugref:9104: Reworking VBoxVersion stuff: Doxy.

File:

• trunk/src/VBox/Frontends/VirtualBox/src/globals/UIVersion.h (modified) (5 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIVersion.h

@@ -19 +19 @@
 #define ___UIVersion_h___
 
-/**
- *  Represents VirtualBox version wrapper
- */
+/** Represents VirtualBox version wrapper. */
 class UIVersion
 {
 public:
 
+    /** Constructs default object. */
     UIVersion() : m_x(-1), m_y(-1), m_z(-1) {}
 
+    /** Constructs object based on parsed @a strVersion. */
     UIVersion(const QString &strVersion)
         : m_x(-1), m_y(-1), m_z(-1)
@@ -40 +40 @@
     }
 
+    /** Assigns this object with value of @a other. */
     UIVersion& operator=(const UIVersion &other) { m_x = other.x(); m_y = other.y(); m_z = other.z(); return *this; }
 
+    /** Returns whether this object is valid. */
     bool isValid() const { return m_x != -1 && m_y != -1 && m_z != -1; }
 
+    /** Returns whether this object is equal to @a other. */
     bool equal(const UIVersion &other) const { return (m_x == other.m_x) && (m_y == other.m_y) && (m_z == other.m_z); }
+    /** Checks whether this object is equal to @a other. */
     bool operator==(const UIVersion &other) const { return equal(other); }
+    /** Checks whether this object is NOT equal to @a other. */
     bool operator!=(const UIVersion &other) const { return !equal(other); }
 
+    /** Checks whether this object is lass than @a other. */
     bool operator<(const UIVersion &other) const
     {
@@ -54 +60 @@
                (m_x == other.m_x && m_y == other.m_y && m_z <  other.m_z);
     }
+    /** Checks whether this object is more than @a other. */
     bool operator>(const UIVersion &other) const
     {
@@ -61 +68 @@
     }
 
+    /** Returns object string representation. */
     QString toString() const
     {
@@ -66 +74 @@
     }
 
+    /** Returns the object X value. */
     int x() const { return m_x; }
+    /** Returns the object Y value. */
     int y() const { return m_y; }
+    /** Returns the object Z value. */
     int z() const { return m_z; }
 
 private:
 
+    /** Holds the object X value. */
     int m_x;
+    /** Holds the object Y value. */
     int m_y;
+    /** Holds the object Z value. */
     int m_z;
 };