Changeset 20896 in vbox for trunk/src/VBox/Main

Timestamp:

Jun 24, 2009 3:38:35 PM (15 years ago)

Author:

vboxsync

Message:

SDK: API doc fixes.

File:

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

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

@@ -2928 +2928 @@
   >
     <desc>
-      Supported virtual file systems of VFSExplorer.
+      Virtual file systems supported by VFSExplorer.
     </desc>
 
@@ -2962 +2962 @@
      >
     <desc>
-      The VFSExplorer interface unify the access to different file system
+      The VFSExplorer interface unifies access to different file system
       types. This includes local file systems as well remote file systems like
-      the S3 one. For a list of supported types see <link to="VFSType" />.
+      S3. For a list of supported types see <link to="VFSType" />.
+      An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
     </desc>
 
     <attribute name="path" type="wstring" readonly="yes">
-      <desc>Return the current path in the virtual file system.</desc>
+      <desc>Returns the current path in the virtual file system.</desc>
     </attribute>
 
     <attribute name="type" type="VFSType" readonly="yes">
-      <desc>Return the file system type which is currently in use.</desc>
+      <desc>Returns the file system type which is currently in use.</desc>
     </attribute>
 
     <method name="update">
-      <desc>This method updates the internal list of files/directories from the
-      current directory level. Use <link to="entryList" /> to get the full list
+      <desc>Updates the internal list of files/directories from the
+      current directory level. Use <link to="#entryList" /> to get the full list
       after a call to this method.</desc>
 
@@ -2986 +2987 @@
 
     <method name="entryList">
-      <desc>Fetch the list of files/directories after a call to <link
-      to="update" />. The user is responcible for keeping this internal list up
-      do date.</desc>
+      <desc>Returns a list of files/directories after a call to <link
+      to="#update" />. The user is responsible for keeping this internal
+      list up do date.</desc>
 
       <param name="aNames" type="wstring" safearray="yes" dir="out">
@@ -3000 +3001 @@
 
     <method name="exists">
-        <desc>Check if the given file list exists in the current directory
+        <desc>Checks if the given file list exists in the current directory
         level.</desc>
 
@@ -3008 +3009 @@
 
       <param name="aExists" type="wstring" safearray="yes" dir="return">
-        <desc>The names which exists.</desc>
+        <desc>The names which exist.</desc>
       </param>
     </method>
 
     <method name="remove">
-        <desc>Remove the given file names from the current directory
-        level.</desc>
+        <desc>Deletes the given files in the current directory level.</desc>
 
       <param name="aNames" type="wstring" safearray="yes" dir="in">