Upstream version 9.38.198.0
[platform/framework/web/crosswalk.git] / src / chrome / common / extensions / api / image_writer_private.idl
index 9fcd3d2..3815b15 100644 (file)
@@ -4,6 +4,9 @@
 
 // Use the <code>chrome.image_writer</code> API to write images to
 // removable media.
+//
+// See the design doc for a detailed description of this API.
+// https://goto.google.com/image-writer-private-designdoc
 [nodoc] namespace imageWriterPrivate {
   // The different stages of a write call.
   //
@@ -44,7 +47,7 @@
   };
 
   dictionary ProgressInfo {
-    // The $ref:Stage that the write process is currently in.
+    // The $(ref:Stage) that the write process is currently in.
     Stage stage;
     // Current progress within the stage.
     long percentComplete;
@@ -55,6 +58,7 @@
     double capacity;
     DOMString vendor;
     DOMString model;
+    boolean removable;
   };
 
   callback WriteImageCallback = void ();
@@ -95,7 +99,7 @@
     // Cancel a current write operation.
     //
     // |callback|: The callback which is triggered with the write is
-    // successfully cancelled, passing the $ref:ProgressInfo of the operation at
+    // successfully cancelled, passing the $(ref:ProgressInfo) of the operation at
     // the time it was cancelled.
     static boolean cancelWrite(WriteCancelCallback callback);
 
     // devices being finalized and resources released.
     static void onWriteComplete();
 
-    // Fires when an error occured during writing, passing the $ref:ProgressInfo
+    // Fires when an error occured during writing, passing the $(ref:ProgressInfo)
     // of the operation at the time the error occured.
     static void onWriteError(ProgressInfo info, DOMString error);