Changeset 29327 in vbox

Timestamp:

May 11, 2010 10:11:29 AM (15 years ago)

Author:

vboxsync

Message:

Main: API docs (SAS)

File:

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

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

@@ -4862 +4862 @@
 
         For an SATA controller, @a controllerPort must be a number ranging
-        from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
-        be a number ranging from @c 0 to @c 15.
-
-        For both SCSI and SATA, the @a device parameter is unused and must
+        from @c 0 to @c 29. For a SCSI or SAS controller, @a controllerPort
+        must be a number ranging from @c 0 to @c 15.
+
+        For SCSI, SAS and SATA, the @a device parameter is unused and must
         be @c 0.
 
@@ -5141 +5141 @@
     <method name="addStorageController">
       <desc>
-        Adds a new storage controller (SCSI or SATA controller) to the
+        Adds a new storage controller (SCSI, SAS or SATA controller) to the
         machine and returns it as an instance of
         <link to="IStorageController" />.
@@ -8573 +8573 @@
     <attribute name="PageFusionEnabled" type="boolean">
       <desc>
-        Flag whether VirtualBox allows page fusion for this machine 
+        Flag whether VirtualBox allows page fusion for this machine
         (64 bits host only; transient property).
       </desc>
@@ -9338 +9338 @@
 
     <attribute name="port" type="long" readonly="yes">
-      <desc>Port number of this attachment.</desc>
+      <desc>Port number of this attachment.
+        See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
+      </desc>
     </attribute>
 
     <attribute name="device" type="long" readonly="yes">
-      <desc>Device slot number of this attachment.</desc>
+      <desc>Device slot number of this attachment.
+        See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
+      </desc>
     </attribute>
 
@@ -9377 +9381 @@
       <ul>
         <li><link to="IMachine::storageControllers"/> contains an array of
-          storage controllers (IDE, SATA, SCSI or a floppy controller;
+          storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
           these are instances of <link to="IStorageController"/>).</li>
         <li><link to="IMachine::mediumAttachments"/> contains an array of
@@ -13686 +13690 @@
   >
     <desc>
-      The bus type of the storage controller (IDE, SATA, SCSI or Floppy);
+      The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
       see <link to="IStorageController::bus" />.
     </desc>
@@ -13752 +13756 @@
         of a storage controller, and for purposes of the Main API, all virtual
         storage is attached to virtual machines via instances of this interface.
-        There are four types of such virtual storage controllers: IDE, SCSI, SATA
-        and Floppy (see <link to="#bus" />). Depending on which of these four is
-        used, certain sub-types may be available and can be selected in
+        There are five types of such virtual storage controllers: IDE, SCSI, SATA,
+        SAS and Floppy (see <link to="#bus" />). Depending on which of these four
+        is used, certain sub-types may be available and can be selected in
         <link to="#controllerType" />.
 
@@ -13805 +13809 @@
     <attribute name="bus" type="StorageBus" readonly="yes">
       <desc>
-        The bus type of the storage controller (IDE, SATA, SCSI or Floppy).
+        The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
       </desc>
     </attribute>
@@ -13815 +13819 @@
         Depending on this value, VirtualBox will provide a different
         virtual storage controller hardware to the guest.
-        For SATA and floppy controllers, only one variant is available,
-        but for IDE and SCSI, there are several.
+        For SATA, SAS and floppy controllers, only one variant is
+        available, but for IDE and SCSI, there are several.
 
         For SCSI controllers, the default type is LsiLogic.