Changeset 101295 in vbox for trunk

Timestamp:

Sep 27, 2023 3:03:51 PM (19 months ago)

Author:

vboxsync

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

159281

Message:

FE/Qt: bugref:10523. Some polishing.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/globals

Files:

• UIGuestOSType.cpp (modified) (5 diffs)
• UIGuestOSType.h (modified) (1 diff)

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIGuestOSType.cpp

@@ -29 +29 @@
 #include "UIGuestOSType.h"
 
+
+/*********************************************************************************************************************************
+*   UIGuestOSType definition.                                                                                     *
+*********************************************************************************************************************************/
 
 /** A wrapper around CGuestOSType. Some of the properties are cached here for performance. */
@@ -74 +78 @@
 };
 
+/*********************************************************************************************************************************
+*   UIGuestOSTypeManager implementaion.                                                                                     *
+*********************************************************************************************************************************/
+
 UIGuestOSTypeManager::UIGuestOSTypeManager()
     :m_guestOSTypes(new QList<UIGuestOSType>())
@@ -81 +89 @@
 void UIGuestOSTypeManager::reCacheGuestOSTypes(const CGuestOSTypeVector &guestOSTypes)
 {
+    AssertReturnVoid(m_guestOSTypes);
     m_typeIdIndexMap.clear();
     m_guestOSTypes->clear();
@@ -102 +111 @@
 void UIGuestOSTypeManager::addGuestOSType(const CGuestOSType &comType)
 {
+    AssertReturnVoid(m_guestOSTypes);
     m_guestOSTypes->append(UIGuestOSType(comType));
     m_typeIdIndexMap[m_guestOSTypes->last().getId()] = m_guestOSTypes->size() - 1;
@@ -230 +240 @@
 }
 
+/*********************************************************************************************************************************
+*   UIGuestOSType implementaion.                                                                                     *
+*********************************************************************************************************************************/
+
 UIGuestOSType::UIGuestOSType()
 {

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

@@ -56 +56 @@
     UIGuestOSTypeManager(const UIGuestOSTypeManager &other) = delete;
 
-    /* A list of all OS families. 'first' of each pair is famil Id and 'second' is family description. */
+    /** A list of all OS families. 'first' of each pair is family Id and 'second' is family description. */
     typedef QVector<QPair<QString, QString> > UIGuestOSTypeFamilyInfo;
+    /** Guest OS type info list for all type.  'first' is typeId and 'second' is description. */
     typedef QVector<QPair<QString, QString> > UIGuestOSTypeInfo;
 
+    /** Re-create the guest OS type database. */
     void reCacheGuestOSTypes(const CGuestOSTypeVector &guestOSTypes);
 
+    /** Returns a list of all families (id and description). */
     const UIGuestOSTypeFamilyInfo &getFamilies() const;
-    QStringList getVariantListForFamilyId(const QString &strFamilyId) const;
+    /** Returns the list of variants for @p strFamilyId. This may be an empty list. */
+    QStringList                    getVariantListForFamilyId(const QString &strFamilyId) const;
+    /** Returns a list of OS types for the @p strFamilyId. */
+    UIGuestOSTypeInfo              getTypeListForFamilyId(const QString &strFamilyId) const;
+    /** Returns a list of OS types for the @p strVariant. */
+    UIGuestOSTypeInfo              getTypeListForVariant(const QString &strVariant) const;
 
-    UIGuestOSTypeInfo getTypeListForFamilyId(const QString &strFamilyId) const;
-    UIGuestOSTypeInfo getTypeListForVariant(const QString &strVariant) const;
-
-    /** @name Getters UIGuestOSType properties. They utilize a map for faster access to UIGuestOSType instance with @p strTypeId
+    /** @name Getters for UIGuestOSType properties. They utilize a map for faster access to UIGuestOSType instance with @p strTypeId
       * @{ */
         QString                 getFamilyId(const QString &strTypeId) const;