Changeset 21061 in vbox for trunk

Timestamp:

Jun 30, 2009 10:01:27 AM (16 years ago)

Author:

vboxsync

Message:

API: fix documentation for a bunch of fixed NULL issues

File:

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

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

@@ -2535 +2535 @@
         server's variable. If the value of the environment variable is
         omitted, this variable will be removed from the resulting environment.
-        If the environment string is @c null or emprty, the server environment
+        If the environment string is @c null or empty, the server environment
         is inherited by the started process as is.
 
@@ -2577 +2577 @@
       <param name="environment" type="wstring" dir="in">
         <desc>
-          Environment to pass to the opened session (may be @c null).
+          Environment to pass to the opened session.
         </desc>
       </param>
@@ -7708 +7708 @@
         The hard disk format set by this attribute is used by VirtualBox
         when the hard disk format was not specified explicitly. One example is
-        <link to="IVirtualBox::createHardDisk"/> with the @c null
+        <link to="IVirtualBox::createHardDisk"/> with the empty
         format argument. A more complex example is implicit creation of
         differencing hard disks when taking a snapshot of a virtual machine:
@@ -8348 +8348 @@
           <link to="#machine"/> object associated with this snapshot
           will point to the saved state file. Otherwise, it will be
-          @c null.
+          an empty string.
         </note>
       </desc>
@@ -8525 +8525 @@
       created for the first time), all known media are in the
       <link to="MediaState_Inaccessible"/> state but the value of the <link
-      to="#lastAccessError"/> attribute is @c null because no actual
+      to="#lastAccessError"/> attribute is an empty string because no actual
       accessibility check is made on startup. This is done to make the
       VirtualBox object ready for serving requests as
@@ -8583 +8583 @@
         medium is <link to="MediaState_LockedRead"/> or
         <link to="MediaState_LockedWrite"/> then it remains the same, and a
-        non-@c null value of <link to="#lastAccessError"/> will indicate a failed
+        non-empty value of <link to="#lastAccessError"/> will indicate a failed
         accessibility check in this case.