Changeset 50198 in vbox

Timestamp:

Jan 23, 2014 6:35:29 PM (11 years ago)

Author:

vboxsync

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

91768

Message:

doxygen

File:

• trunk/src/VBox/Main/include/ApplianceImpl.h (modified) (6 diffs)

trunk/src/VBox/Main/include/ApplianceImpl.h

@@ -116 +116 @@
     enum SetUpProgressMode { ImportFile, ImportS3, WriteFile, WriteS3 };
 
-    /*******************************************************************************
-     * General stuff
-     ******************************************************************************/
-
+    /** @name General stuff
+     * @{
+     */
     bool i_isApplianceIdle();
     HRESULT i_searchUniqueVMName(Utf8Str& aName) const;
@@ -144 +143 @@
 
     HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
-
-    /*******************************************************************************
-     * Read stuff
-     ******************************************************************************/
-
+    /** @}  */
+
+    /** @name Read stuff
+     * @{
+     */
     HRESULT i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
 
@@ -156 +155 @@
     HRESULT i_readFSImpl(TaskOVF *pTask, const RTCString &strFilename, PVDINTERFACEIO pCallbacks, PSHASTORAGE pStorage);
     HRESULT i_readS3(TaskOVF *pTask);
-
-    /*******************************************************************************
-     * Import stuff
-     ******************************************************************************/
-
+    /** @}  */
+
+    /** @name Import stuff
+     * @}
+     */
     HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
 
@@ -211 +210 @@
                           PSHASTORAGE pStorage);
 
-    /*******************************************************************************
-     * Write stuff
-     ******************************************************************************/
-
+    HRESULT i_preCheckImageAvailability(PSHASTORAGE pSHAStorage,
+                                        RTCString &availableImage);
+    /** @} */
+
+    /** @name Write stuff
+     * @{
+     */
     HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
 
@@ -236 +238 @@
                                        ovf::OVFVersion_T enFormat,
                                        XMLStack &stack);
-
-    HRESULT i_preCheckImageAvailability(PSHASTORAGE pSHAStorage,
-                                        RTCString &availableImage);
+    /** @} */
 
     friend class Machine;
@@ -247 +247 @@
 struct VirtualSystemDescriptionEntry
 {
-    uint32_t ulIndex;                       // zero-based index of this entry within array
-    VirtualSystemDescriptionType_T type;    // type of this entry
-    Utf8Str strRef;                         // reference number (hard disk controllers only)
-    Utf8Str strOvf;                         // original OVF value (type-dependent)
-    Utf8Str strVBoxSuggested;               // configuration value (type-dependent); original value suggested by interpret()
-    Utf8Str strVBoxCurrent;                 // configuration value (type-dependent); current value, either from interpret() or setFinalValue()
-    Utf8Str strExtraConfigSuggested;        // extra configuration key=value strings (type-dependent); original value suggested by interpret()
-    Utf8Str strExtraConfigCurrent;          // extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
-
-    uint32_t ulSizeMB;                      // hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
+    uint32_t ulIndex;                       ///< zero-based index of this entry within array
+    VirtualSystemDescriptionType_T type;    ///< type of this entry
+    Utf8Str strRef;                         ///< reference number (hard disk controllers only)
+    Utf8Str strOvf;                         ///< original OVF value (type-dependent)
+    Utf8Str strVBoxSuggested;               ///< configuration value (type-dependent); original value suggested by interpret()
+    Utf8Str strVBoxCurrent;                 ///< configuration value (type-dependent); current value, either from interpret() or setFinalValue()
+    Utf8Str strExtraConfigSuggested;        ///< extra configuration key=value strings (type-dependent); original value suggested by interpret()
+    Utf8Str strExtraConfigCurrent;          ///< extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
+
+    uint32_t ulSizeMB;                      ///< hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
 };