Changeset 65158 in vbox

Timestamp:

Jan 5, 2017 4:52:22 PM (8 years ago)

Author:

vboxsync

Message:

Main: doxygen fixes

Location:

trunk

Files:

• Doxyfile.Core (modified) (1 diff)
• src/VBox/Main/include/Global.h (modified) (1 diff)
• src/VBox/Main/include/MachineImpl.h (modified) (1 diff)
• src/VBox/Main/include/Matching.h (modified) (2 diffs)
• src/VBox/Main/src-server/MachineImpl.cpp (modified) (9 diffs)
• src/VBox/Main/src-server/VirtualBoxImpl.cpp (modified) (3 diffs)
• src/VBox/Main/webservice/vboxweb.h (modified) (2 diffs)

trunk/Doxyfile.Core

@@ -561 +561 @@
     GMMR0DECL(type)=type \
     GMMR3DECL(type)=type \
-    VBOX_DND_FN_DECL_LOG(x)=x
+    VBOX_DND_FN_DECL_LOG(x)=x \
+    DECLSPEC_HIDDEN= \
+    VMSVGA3DCOCOA_DECL(type)=type \
+    VBOX_LISTENER_DECLARE(a)=
 
 # BS3Kit

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

@@ -99 +99 @@
      * recommended way to detect if the VM is online (being executed in a
      * dedicated process) or not. Note that some online states are also
-     * transitional states (see #IsTransitional()).
+     * transitional states (see #IsTransient()).
      */
     static bool IsOnline(MachineState_T aState)

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

@@ -668 +668 @@
         /* flags for #saveSettings() */
         SaveS_ResetCurStateModified = 0x01,
-        SaveS_InformCallbacksAnyway = 0x02,
         SaveS_Force = 0x04,
         /* flags for #saveStateSettings() */

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

@@ -44 +44 @@
     ParsedFilter_base() : mValid (false), mNull (true), mErrorPosition (0) {};
 
+    /**
+     * Returns @c true if the filter is valid, @c false otherwise.
+     */
     bool isValid() const { return mNull || mValid; }
     bool isNull() const { return mNull; }
@@ -56 +59 @@
 
     /**
-     *  Returns true if current isNull() and isValid() values make further
-     *  detailed matching meaningful, otherwise returns false.
+     *  Returns @c true if current isNull() and isValid() values make further
+     *  detailed matching meaningful, otherwise returns @c false.
      *  Must be called as a first method of every isMatch() implementation,
-     *  so that isMatch() will immediately return false if isPreMatch() returns
+     *  so that isMatch() will immediately return @c false if isPreMatch() returns
      *  false.
      */

trunk/src/VBox/Main/src-server/MachineImpl.cpp

@@ -933 +933 @@
         if (mData->pMachineConfigFile)
         {
-            // reset the XML file to force loadSettings() (called from registeredInit())
+            // reset the XML file to force loadSettings() (called from i_registeredInit())
             // to parse it again; the file might have changed
             delete mData->pMachineConfigFile;
@@ -8118 +8118 @@
  * Increases the number of objects dependent on the machine state or on the
  * registered state. Guarantees that these two states will not change at least
- * until #releaseStateDependency() is called.
+ * until #i_releaseStateDependency() is called.
  *
  * Depending on the @a aDepType value, additional state checks may be made.
  * These checks will set extended error info on failure. See
- * #checkStateDependency() for more info.
+ * #i_checkStateDependency() for more info.
  *
  * If this method returns a failure, the dependency is not added and the caller
@@ -8175 +8175 @@
 /**
  * Decreases the number of objects dependent on the machine state.
- * Must always complete the #addStateDependency() call after the state
+ * Must always complete the #i_addStateDependency() call after the state
  * dependency is no more necessary.
  */
@@ -8251 +8251 @@
  *  @param aDepType     Dependency type to check.
  *
- *  @note Non Machine based classes should use #addStateDependency() and
- *  #releaseStateDependency() methods or the smart AutoStateDependency
+ *  @note Non Machine based classes should use #i_addStateDependency() and
+ *  #i_releaseStateDependency() methods or the smart AutoStateDependency
  *  template.
  *
@@ -8342 +8342 @@
  * (usually done in the #init() method).
  *
- * @note Must be called only from #init() or from #registeredInit().
+ * @note Must be called only from #init() or from #i_registeredInit().
  */
 HRESULT Machine::initDataAndChildObjects()
@@ -8422 +8422 @@
  * procedure (usually done in the #uninit() method).
  *
- * @note Must be called only from #uninit() or from #registeredInit().
+ * @note Must be called only from #uninit() or from #i_registeredInit().
  */
 void Machine::uninitDataAndChildObjects()
@@ -8692 +8692 @@
  *
  * -- When machine XML exists on disk already and needs to be loaded into memory,
- *    for example, from registeredInit() to load all registered machines on
+ *    for example, from #i_registeredInit() to load all registered machines on
  *    VirtualBox startup. In this case, puuidRegistry is NULL because the media
  *    attached to the machine should be part of some media registry already.
@@ -9958 +9958 @@
  *    Used when saving settings after an operation that makes them 100%
  *    correspond to the settings from the current snapshot.
- *  - SaveS_InformCallbacksAnyway: Callbacks will be informed even if
- *    #isReallyModified() returns false. This is necessary for cases when we
- *    change machine data directly, not through the backup()/commit() mechanism.
  *  - SaveS_Force: settings will be saved without doing a deep compare of the
  *    settings structures. This is used when this is called because snapshots
@@ -10069 +10066 @@
     }
 
-    if (fNeedsWrite || (aFlags & SaveS_InformCallbacksAnyway))
+    if (fNeedsWrite)
     {
         /* Fire the data change event, even on failure (since we've already

trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

@@ -5049 +5049 @@
  *
  * When @a aSaveSettings is @c true, this operation may fail because of the
- * failed #saveSettings() method it calls. In this case, the dhcp server object
+ * failed #i_saveSettings() method it calls. In this case, the dhcp server object
  * will not be remembered. It is therefore the responsibility of the caller to
  * call this method as the last step of some action that requires registration
@@ -5114 +5114 @@
  * @param aDHCPServer   DHCP server object to remove.
  *
- * This operation may fail because of the failed #saveSettings() method it
+ * This operation may fail because of the failed #i_saveSettings() method it
  * calls. In this case, the DHCP server will NOT be removed from the settings
  * when this method returns.
@@ -5295 +5295 @@
  *
  * When @a aSaveSettings is @c true, this operation may fail because of the
- * failed #saveSettings() method it calls. In this case, the DHCP server
+ * failed #i_saveSettings() method it calls. In this case, the DHCP server
  * will NOT be removed from the settingsi when this method returns.
  *

trunk/src/VBox/Main/webservice/vboxweb.h

@@ -193 +193 @@
          * Returns the contained COM pointer and the UUID of the COM interface
          * which it supports.
-         * @param
+         * @param   ppobjInterface
+         * @param   ppobjUnknown
          * @return
          */
@@ -317 +318 @@
  * @param idParent managed object reference of calling object; used to extract
  *              websession ID
+ * @param pcszInterface
  * @param pc COM object for which to create a reference
  * @return existing or new managed object reference