Changeset 51527 in vbox for trunk/src/VBox

Timestamp:

Jun 4, 2014 10:50:38 AM (11 years ago)

Author:

vboxsync

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

94160

Message:

Main: Documentation.

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (11 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -738 +738 @@
           comparisons in the old source code valid, this state must immediately
           precede the Paused state.
-          TODO: Lift this spectacularly wonderful restriction.
+
+          @todo Lift this spectacularly wonderful restriction.
         </note>
       </desc>
@@ -749 +750 @@
           comparisons in the old source code valid, this state must immediately
           follow the Running state.
-          TODO: Lift this spectacularly wonderful restriction.
+
+          @todo Lift this spectacularly wonderful restriction.
         </note>
       </desc>
@@ -8222 +8224 @@
         Teleport the VM to a different host machine or process.
 
-        TODO explain the details.
+        @todo Explain the details.
 
         <result name="VBOX_E_INVALID_VM_STATE">
@@ -12145 +12147 @@
     <attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
       <desc>
-        Current run level of the Guest Additions.
+        Current run level of the installed Guest Additions.
       </desc>
     </attribute>
@@ -12151 +12153 @@
     <attribute name="additionsVersion" type="wstring" readonly="yes">
       <desc>
-        Version of the Guest Additions in the same format as
+        Version of the installed Guest Additions in the same format as
         <link to="IVirtualBox::version"/>.
       </desc>
@@ -12158 +12160 @@
     <attribute name="additionsRevision" type="unsigned long" readonly="yes">
       <desc>
-        The internal build revision number of the additions.
+        The internal build revision number of the installed Guest Additions.
 
         See also <link to="IVirtualBox::revision"/>.
@@ -12166 +12168 @@
     <attribute name="dnDSource" type="IGuestDnDSource" readonly="yes">
       <desc>
-        TODO
+        Retrieves the drag'n drop source implementation for the guest side, that
+        is, handling and retrieving drag'n drop data from the guest.
       </desc>
     </attribute>
@@ -12172 +12175 @@
     <attribute name="dnDTarget" type="IGuestDnDTarget" readonly="yes">
       <desc>
-        TODO
+        Retrieves the drag'n drop source implementation for the host side. This
+        will allow the host to handle and initiate a drag'n drop operation to copy
+        data from the host to the guest.
       </desc>
     </attribute>
@@ -12184 +12189 @@
     <attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
       <desc>
-        Array of current known facilities. Only returns facilities where a status is known,
-        e.g. facilities with an unknown status will not be returned.
+        Returns a collection of current known facilities. Only returns facilities where
+        a status is known, e.g. facilities with an unknown status will not be returned.
       </desc>
     </attribute>
@@ -19562 +19567 @@
       Interface for managing VirtualBox Extension Packs.
 
-      TODO: Describe extension packs, how they are managed and how to create
-            one.
+      @todo Describe extension packs, how they are managed and how to create one.
     </desc>
 
@@ -21069 +21073 @@
     <desc>
       The mode (relative, absolute, multi-touch) of a pointer event.
-      TODO: a clear pattern seems to be emerging that we should usually have
+
+      @todo A clear pattern seems to be emerging that we should usually have
       multiple input devices active for different types of reporting, so we
       should really have different event types for relative (including wheel),