2009/dap/system-info Overview.html,1.46,1.47

Update of /sources/public/2009/dap/system-info
In directory hutz:/tmp/cvs-serv4039

Modified Files:
	Overview.html 
Log Message:
Changes after doug's comments:
- removed UNKNOWN_ERROR
- removed error message
- make info optional
- fix error in ThermalState declaration

And also:
- some text and a reference about PendingOp


Index: Overview.html
===================================================================
RCS file: /sources/public/2009/dap/system-info/Overview.html,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -d -r1.46 -r1.47
--- Overview.html	18 Dec 2009 15:52:45 -0000	1.46
+++ Overview.html	21 Dec 2009 12:30:14 -0000	1.47
@@ -291,6 +291,8 @@
           </dd>
         </dl>
 
+        <p>All functions return a <a>PendingOp</a> object, defined in [[!CORE-DEVICE]], which has a <a>cancel</a> function allowing the asynchronous operation to be interrupted.</p>
+
         <section>
           <h2>Callback interfaces</h2>
           <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface SuccessCB' class='idl'>
@@ -316,23 +318,20 @@
         <section>
           <h2>The Error interface</h2>
           <dl title='[NoInterfaceObject] interface Error' class='idl'>
-            <dt>const unsigned short UNKNOWN_ERROR = 0</dt>
-            <dd>The reason for an error being triggered is unknown.</dd>
-            
-            <dt>const unsigned short PERMISSION_DENIED = 1</dt>
+            <dt>const unsigned short PERMISSION_DENIED = 0</dt>
             <dd>The application context does not have permission to
             access this property</dd>
             
-            <dt>const unsigned short INFORMATION_UNAVAILABLE = 2</dt>
+            <dt>const unsigned short INFORMATION_UNAVAILABLE = 1</dt>
             <dd>The property accessed is unavailable on this device (e.g. the battery level on a device that only has an external power source).</dd>
 
-            <dt>const unsigned short INVALID_VALUE = 3</dt>
+            <dt>const unsigned short INVALID_VALUE = 2</dt>
             <dd>One or more of the values in the <a>Options</a>
             obect passed was invalid. For example, if the
             <a>highThreshold</a> attribute is set to a value
             greater than 1.0 for the CpuLoad property.</dd>
 
-            <dt>const unsigned short READ_ONLY = 3</dt>
+            <dt>const unsigned short READ_ONLY = 4</dt>
             <dd>The property that has been passed to the
             <a>set</a> function that has triggered this callback
             cannot be modified.</dd>
@@ -342,14 +341,6 @@
             error values defined in this specification. An implementation MAY
             define additional error codes, but those MUST NOT use the numeric
             values defined here.</dd>
-
-            <dt>readonly attribute DOMString message</dt>
-            <dd>The <a>message</a> attribute MAY return an error
-            message describing the details of the error encountered. This
-            attribute is primarily intended for debugging and developers
-            SHOULD NOT use it directly in their application user
-            interface.
-            </dd>
           </dl>
         </section>
 
@@ -471,7 +462,7 @@
             <dt>readonly attribute unsigned int type</dt>
             <dd>One of the constants defined in this interface, reflecting the state of this source</dd>
             
-            <dt>readonly attribute DOMString info</dt>
+            <dt>readonly attribute DOMString? info</dt>
             <dd>A free-form string describing this device</dd>
             
             <dt>readonly attribute DOMString id</dt>
@@ -536,7 +527,7 @@
           <p>This property contains the data pertaining to a single CPU on the system. It is <a>enumerable</a>.</p>
 
           <dl title="[NoInterfaceObject] interface Cpu" class="idl">
-            <dt>readonly attribute DOMString info</dt>
+            <dt>readonly attribute DOMString? info</dt>
             <dd>A free-form string describing this CPU</dd>
 
             <dt>readonly attribute DOMString id</dt>
@@ -601,7 +592,7 @@
               temperature of the system.
             </dd>
 
-            <dt>readonly attribute sequence &lt;Thermometer&gt; thermometers</dt>
+            <dt>readonly attribute Thermometer thermometers[]</dt>
             <dd>The list of all the system's internal themometers</dd>
           </dl>
         </section>
@@ -610,7 +601,7 @@
           <p>This property exposes the state of a single internal thermometer available to the system. It is <a>enumerable</a></p>
 
           <dl title="[NoInterfaceObject] interface Thermometer" class="idl">
-            <dt>readonly attribute DOMString info</dt>
+            <dt>readonly attribute DOMString? info</dt>
             <dd>A free-form string describing this Thermometer</dd>
             <dt>readonly attribute DOMString id</dt>
             <dd>A free-form string identifying this device. The value of this element MUST be unique within the list reported by the <a>thermometers</a> attribute of a <a>ThermalState</a> object.</dd>
@@ -656,7 +647,7 @@
             <dd>A liquid submersion cooling device</dd>
             <dt>readonly attribute unsigned short type</dt>
             <dd>This attributes takes a value among the constants defined in this interface, indicating the type of cooling device that this object reflects.</dd>
-            <dt>readonly attribute DOMString info</dt>
+            <dt>readonly attribute DOMString? info</dt>
             <dd>A free-form string describing this cooling device</dd>
             <dt>readonly attribute DOMString id</dt>
             <dd>A free-form string identifying this device. The value of this element MUST be unique within the list reported by the <a>devices</a> of a <a>CoolingSystem</a> object.</dd>
@@ -803,7 +794,7 @@
             <dt>readonly attribute unsigned short type</dt>
             <dd>This attribute indicates the network technology in use on a network.</dd>
 
-            <dt>readonly attribute DOMString info</dt>
+            <dt>readonly attribute DOMString? info</dt>
             <dd>A free-form string describing this connection</dd>
             
             <dt>readonly attribute DOMString id</dt>
@@ -883,7 +874,7 @@
             <p>This property provides information about a single external light sensor available to the system. It is <a>enumerable</a>.</p>
 
             <dl title="[NoInterfaceObject] interface AmbientLightSensor" class="idl">
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>A free-form string describing this device.</dd>
               <dt>readonly attribute DOMString id</dt>
               <dd>A free-form string identifying this sensor. The value of this element MUST be unique within the list reported in the <a>sensors</a> attribute of an <a>AmbientLight</a> object.</dd>
@@ -919,7 +910,7 @@
             <p>This property provides information about a single ambient noise sensor available to the system. It is <a>enumerable.</a></p>
 
             <dl title="[NoInterfaceObject] interface AmbientNoiseSensor" class="idl">
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>A free-form string describing this device.</dd>
               <dt>readonly attribute DOMString id</dt>
               <dd>A free-form string identifying this sensor. The value of this element MUST be unique within the list reported in the <a>sensors</a> attribute of an <a>AmbientLight</a> object.</dd>
@@ -978,7 +969,7 @@
             <dl title="[NoInterfaceObject] interface Barometer" class="idl">
               <dt>readonly attribute DOMString id</dt>
               <dd>A free-form string identifying this barometer. The value of this element MUST be unique within the list reported in the <a>barometers</a> attribute of the related <a>AmbientAtmosphericPressure</a> object.</dd>
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>A free-form string describing this device.</dd>
               <dt>readonly attribute float currentPressure</dt>
               <dd>The current atmospheric pressure measured by this device, in kiloPascal (kPa)</dd>.
@@ -1020,7 +1011,7 @@
               value of this element MUST be unique within the list
               reported in a <a>Proximity</a> object.</dd>
 
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>A free-form string describing this device.</dd>
 
               <dt>readonly attribute float distance</dt>
@@ -1066,7 +1057,7 @@
           <p>This property exposes information on a single audio codec available to this system. Is it <a>enumerable</a>.</p>
 
           <dl title='[NoInterfaceObject] interface AudioCodec' class='idl'>
-            <dt>readonly attribute DOMString info</dt>
+            <dt>readonly attribute DOMString? info</dt>
             <dd>Free-form string containing information on this
             codec's implementation. Examples: "Microsoft G.711",
             "LAME".</dd>
@@ -1089,7 +1080,7 @@
             <h3>The <a>VideoCodec</a> Property</h3>                
             <dl title='[NoInterfaceObject] interface VideoCodec' class='idl'>
               
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>Freeform string describing this video codec. Example : "Indeo Video" or "libtheora"</dd>
               <dt>readonly attribute DOMString id</dt>
               <dd>A free-form string identifying this codec. The value of this element MUST be unique within the list reported by the <a>codecs</a> attribute of a <a>Video</a> object.</dd>
@@ -1171,7 +1162,7 @@
               <dt>readonly attribute unsigned short type</dt>
               <dd>The type of pointing device. The value is one of the constants defined for this type.</dd>
               
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>A free-form string describing this device</dd>
               <dt>readonly attribute DOMString id</dt>
               <dd>A free-form string identifying this device. The value of this element MUST be unique within the list reported in the <a>units</a> attribute of an <a>Storage</a> object.</dd>
@@ -1259,7 +1250,7 @@
               <p>The <a>DisplayDevice</a> interface defined below inherits from the <a>Screen</a> interface as defined in [[!CSSOM-VIEW]]</p>
               
               <dl title="[NoInterfaceObject] interface DisplayDevice : Screen" class="idl">
-                <dt>readonly attribute DOMString info</dt>
+                <dt>readonly attribute DOMString? info</dt>
                 <dd>A free-form string describing this device</dd>
                 
                 <dt>readonly attribute DOMString id</dt>
@@ -1333,7 +1324,7 @@
                 <dt>readonly attribute unsigned short type</dt>
                 <dd>The type of audio output device. The value is one of the constants defined for this type.</dd>
                 
-                <dt>readonly attribute DOMString info</dt>
+                <dt>readonly attribute DOMString? info</dt>
                 <dd>Free-form text describing this device.</dd>
                 
                 <dt>readonly attribute DOMString id</dt>
@@ -1399,7 +1390,7 @@
               <dd>When the <a>type</a> attribute has this value, then this device is a graphics tablet</dd>
               <dt>readonly attribute unsigned short type</dt>
               <dd>The type of pointing device. The value is one of the constants defined for this type.</dd>
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>A free-form string describing this device</dd>
               <dt>readonly attribute DOMString id</dt>
               <dd>A free-form string identifying this device. The value of this element MUST be unique within the list reported in the <a>pointingDevices</a> attribute of an <a>InputDevice</a> object.</dd>
@@ -1420,7 +1411,7 @@
               <dt>readonly attribute unsigned short type</dt>
               <dd>The type of pointing device. The value is one of the constants defined for this type.</dd>
 
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>A free-form string describing this device</dd>
               <dt>readonly attribute DOMString id</dt>
               <dd>A free-form string identifying this device. The value of this element MUST be unique within the list reported in the <a>keyboards</a> attribute of an <a>InputDevice</a> object.</dd>
@@ -1434,7 +1425,7 @@
             <h4>The <a>Camera</a> Property</h4>
             <p>This property exposes the cameras connected to this system. It is <a>enumerable</a>.</p>
             <dl title="interface Camera" class="idl">
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>A free-form string describing this device</dd>
               <dt>readonly attribute DOMString id</dt>
               <dd>A free-form string identifying this device. The value of this element MUST be unique within the list reported in the <a>cameras</a> attribute of an <a>InputDevice</a> object.</dd>
@@ -1469,7 +1460,7 @@
               <dd>The type of audio input device. The value is one of
               the constants defined for this type.</dd>
 
-              <dt>readonly attribute DOMString info</dt>
+              <dt>readonly attribute DOMString? info</dt>
               <dd>Free-form text describing this device.</dd>
 
               <dt>readonly attribute DOMString id</dt>

Received on Monday, 21 December 2009 12:30:18 UTC