Changeset 66217 in vbox

Timestamp:

Mar 23, 2017 9:33:56 AM (8 years ago)

Author:

vboxsync

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

114135

Message:

Main: a few doxygen fixes

Location:

trunk/src/VBox/Main

Files:

trunk/src/VBox/Main/src-client/SessionImpl.cpp

-              r65103
+              r66217
  *                          and later reacquired during the unlocking.
+ *
+ *  @note To be called only from #uninit(), #UnlockMachine() or #Uninitialize().
+ *  @note To be called only from #uninit(), ISession::UnlockMachine() or
+ *        ISession::Uninitialize().
  */
 HRESULT Session::i_unlockMachine(bool aFinalRelease, bool aFromServer, AutoWriteLock &aLockW)

-              r66126
+              r66217
  * This method assumes that mMediumAttachments contains the original hard disk
  * attachments it needs to create diffs for. On success, these attachments will
+ * be replaced with the created diffs. On failure, #deleteImplicitDiffs() is
+ * implicitly called to delete created diffs which will also rollback
+ * mMediumAttachments and restore whatever was backed up before calling this
+ * method.
+ * be replaced with the created diffs.
+ *
  * Attachments with non-normal hard disks are left as is.
 …
+ *
  * Note that to delete hard disks created by #attachDevice() this method is
  * called from #fixupMedia() when the changes are rolled back.
+ * called from #i_rollbackMedia() when the changes are rolled back.
+ *
  * @note Locks this object and the media tree for writing.
 …
  * @note This method must be called from under this object's lock.
+ *
  * @note This method doesn't call #commit(), so all data remains backed up and
+ * @note This method doesn't call #i_commit(), so all data remains backed up and
  *       unsaved.
  */

-              r65158
+              r66217
 /**
  *  Abstract callback event class to asynchronously call VirtualBox callbacks
+ *  on a dedicated event thread. Subclasses reimplement #handleCallback()
+ *  to call appropriate IVirtualBoxCallback methods depending on the event
+ *  to be dispatched.
+ *  on a dedicated event thread. Subclasses reimplement #prepareEventDesc()
+ *  to initialize the event depending on the event to be dispatched.
+ *
  *  @note The VirtualBox instance passed to the constructor is strongly
 …
 /**
  *  Adds the given child process ID to the list of processes to be reaped.
  *  This call should be followed by #updateClientWatcher() to take the effect.
+ *  This call should be followed by #i_updateClientWatcher() to take the effect.
+ *
  *  @note Doesn't lock anything.
 …
 /**
  *  Thread function that handles custom events posted using #postEvent().
+ *  Thread function that handles custom events posted using #i_postEvent().
  */
 // static
 …
 /**
+ *  Takes the current list of registered callbacks of the managed VirtualBox
+ *  instance, and calls #handleCallback() for every callback item from the
+ *  list, passing the item as an argument.
+ * Prepare the event using the overwritten #prepareEventDesc method and fire.
+ *
  *  @note Locks the managed VirtualBox object for reading but leaves the lock

Note: See TracChangeset for help on using the changeset viewer.