Updates API documentation after r147399.

BUG=135689
TEST=none

Review URL: https://chromiumcodereview.appspot.com/10810032

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@147617 0039d316-1c4b-4281-b951-d872f2087c98

5 files changed, 266 insertions, 11 deletions

diff --git a/chrome/common/extensions/PRESUBMIT.py b/chrome/common/extensions/PRESUBMIT.py
index b621d4b..491c37a 100644
--- a/chrome/common/extensions/PRESUBMIT.py
+++ b/chrome/common/extensions/PRESUBMIT.py
@@ -24,7 +24,8 @@ REBUILD_WARNING = (
     'not been updated properly. See %s for more info.' % README)
 BUILD_SCRIPT = os.path.join(BUILD_DIR, 'build.py')
 REBUILD_INSTRUCTIONS = (
-    'First build DumpRenderTree, then update the docs by running:\n  %s' %
+    'First build DumpRenderTree, then update the docs by running:\n  %s'
+    ' --page-name=<apiName>' %
     BUILD_SCRIPT)
 
 
diff --git a/chrome/common/extensions/PRESUBMIT_test.py b/chrome/common/extensions/PRESUBMIT_test.py
index b646bec..68cd1c0 100755
--- a/chrome/common/extensions/PRESUBMIT_test.py
+++ b/chrome/common/extensions/PRESUBMIT_test.py
@@ -65,7 +65,8 @@ class TestPresubmit(unittest.TestCase):
         ' - Changes to %s not reflected in generated doc.\n'
         ' - Changes to sample %s have not been re-zipped.\n'
         ' - Docs out of sync with %s changes.\n'
-        'First build DumpRenderTree, then update the docs by running:\n  %s' %
+        'First build DumpRenderTree, then update the docs by running:\n  %s'
+        ' --page-name=<apiName>' %
         (os.path.normpath('chrome/common/extensions/docs/README.txt'),
          os.path.normpath('chrome/common/extensions/docs/static/foo.html'),
          os.path.normpath('chrome/common/extensions/docs/examples/foo/b/bz.js'),
@@ -83,7 +84,8 @@ class TestPresubmit(unittest.TestCase):
         'have not been updated properly. See %s for more info.\n'
         ' - Changes to generated doc %s not reflected in non-generated files.\n'
         ' - Changes to generated doc %s not reflected in non-generated files.\n'
-        'First build DumpRenderTree, then update the docs by running:\n  %s' %
+        'First build DumpRenderTree, then update the docs by running:\n  %s'
+        ' --page-name=<apiName>' %
         (os.path.normpath('chrome/common/extensions/docs/README.txt'),
          os.path.normpath('chrome/common/extensions/docs/bar.html'),
          os.path.normpath('chrome/common/extensions/docs/foo.html'),
diff --git a/chrome/common/extensions/docs/apps/fileSystem.html b/chrome/common/extensions/docs/apps/fileSystem.html
index 4945a53..bbc146a 100644
--- a/chrome/common/extensions/docs/apps/fileSystem.html
+++ b/chrome/common/extensions/docs/apps/fileSystem.html
@@ -175,6 +175,8 @@
                 <a href="#method-getDisplayPath">getDisplayPath</a>
               </li><li>
                 <a href="#method-getWritableFileEntry">getWritableFileEntry</a>
+              </li><li>
+                <a href="#method-isWritableFileEntry">isWritableFileEntry</a>
               </li>
             </ol>
           </li>
@@ -295,7 +297,7 @@
                   (
                     <span id="typeTemplate">
                       <span>
-                        <span>fileEntry</span>
+                        <span>FileEntry</span>
                       </span>
                     </span>
                   )
@@ -503,7 +505,111 @@
                   (
                     <span id="typeTemplate">
                       <span>
-                        <span>fileEntry</span>
+                        <span>FileEntry</span>
+                      </span>
+                    </span>
+                  )
+                </div>
+              </em>
+          </dt>
+          <dd class="todo">
+            Undocumented.
+          </dd>
+          <!-- OBJECT PROPERTIES -->
+          <!-- OBJECT METHODS -->
+          <!-- OBJECT EVENT FIELDS -->
+          <!-- FUNCTION PARAMETERS -->
+        </div>
+            </div>
+          </dl>
+        </div>
+          </dd>
+        </div>
+                  </div>
+                </dl>
+                <!-- RETURNS -->
+                <dl>
+                </dl>
+                <!-- CALLBACK -->
+                <!-- MIN_VERSION -->
+              </div> <!-- /description -->
+            </div><div class="apiItem">
+              <a name="method-isWritableFileEntry"></a> <!-- method-anchor -->
+              <h4>isWritableFileEntry</h4>
+              <div class="summary">
+                  <!-- Note: intentionally longer 80 columns -->
+                  <span>chrome.fileSystem.isWritableFileEntry</span>(<span class="null"><span>FileEntry</span>
+                      <var><span>fileEntry</span></var></span><span class="null"><span>, </span><span>function</span>
+                      <var><span>IsWritableCallback</span></var></span>)</div>
+              <div class="description">
+                <p>Gets whether this FileEntry is writable or not.</p>
+                <!-- PARAMETERS -->
+                <h4>Parameters</h4>
+                <dl>
+                  <div>
+                    <div>
+          <dt>
+            <var>fileEntry</var>
+              <em>
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span id="typeTemplate">
+                      <span>
+                        <span>FileEntry</span>
+                      </span>
+                    </span>
+                  )
+                </div>
+              </em>
+          </dt>
+          <dd class="todo">
+            Undocumented.
+          </dd>
+          <!-- OBJECT PROPERTIES -->
+          <!-- OBJECT METHODS -->
+          <!-- OBJECT EVENT FIELDS -->
+          <!-- FUNCTION PARAMETERS -->
+        </div>
+                  </div><div>
+                    <div>
+          <dt>
+            <var>IsWritableCallback</var>
+              <em>
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span id="typeTemplate">
+                      <span>
+                        <span>function</span>
+                      </span>
+                    </span>
+                  )
+                </div>
+              </em>
+          </dt>
+          <dd class="todo">
+            Undocumented.
+          </dd>
+          <!-- OBJECT PROPERTIES -->
+          <!-- OBJECT METHODS -->
+          <!-- OBJECT EVENT FIELDS -->
+          <!-- FUNCTION PARAMETERS -->
+          <dd>
+            <div>
+          <h5>Parameters</h5>
+          <dl>
+            <div>
+              <div>
+          <dt>
+            <var>isWritable</var>
+              <em>
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span id="typeTemplate">
+                      <span>
+                        <span>boolean</span>
                       </span>
                     </span>
                   )
diff --git a/chrome/common/extensions/docs/extensions/fileSystem.html b/chrome/common/extensions/docs/extensions/fileSystem.html
index fe06398..e5e88ac 100644
--- a/chrome/common/extensions/docs/extensions/fileSystem.html
+++ b/chrome/common/extensions/docs/extensions/fileSystem.html
@@ -204,6 +204,8 @@
                 <a href="#method-getDisplayPath">getDisplayPath</a>
               </li><li>
                 <a href="#method-getWritableFileEntry">getWritableFileEntry</a>
+              </li><li>
+                <a href="#method-isWritableFileEntry">isWritableFileEntry</a>
               </li>
             </ol>
           </li>
@@ -324,7 +326,7 @@
                   (
                     <span id="typeTemplate">
                       <span>
-                        <span>fileEntry</span>
+                        <span>FileEntry</span>
                       </span>
                     </span>
                   )
@@ -358,7 +360,7 @@
                     that looks like this:
                   </p>
                   <!-- Note: intentionally longer 80 columns -->
-                  <pre>function(<span>fileEntry fileEntry</span>) <span class="subdued">{...}</span>;</pre>
+                  <pre>function(<span>FileEntry fileEntry</span>) <span class="subdued">{...}</span>;</pre>
                   <dl>
                     <div>
                       <div>
@@ -370,7 +372,7 @@
                   (
                     <span id="typeTemplate">
                       <span>
-                        <span>fileEntry</span>
+                        <span>FileEntry</span>
                       </span>
                     </span>
                   )
@@ -610,7 +612,7 @@
                   (
                     <span id="typeTemplate">
                       <span>
-                        <span>fileEntry</span>
+                        <span>FileEntry</span>
                       </span>
                     </span>
                   )
@@ -644,7 +646,7 @@
                     that looks like this:
                   </p>
                   <!-- Note: intentionally longer 80 columns -->
-                  <pre>function(<span>fileEntry fileEntry</span>) <span class="subdued">{...}</span>;</pre>
+                  <pre>function(<span>FileEntry fileEntry</span>) <span class="subdued">{...}</span>;</pre>
                   <dl>
                     <div>
                       <div>
@@ -656,7 +658,150 @@
                   (
                     <span id="typeTemplate">
                       <span>
-                        <span>fileEntry</span>
+                        <span>FileEntry</span>
+                      </span>
+                    </span>
+                  )
+                </div>
+              </em>
+          </dt>
+          <dd class="todo">
+            Undocumented.
+          </dd>
+          <!-- OBJECT PROPERTIES -->
+          <!-- OBJECT METHODS -->
+          <!-- OBJECT EVENT FIELDS -->
+          <!-- FUNCTION PARAMETERS -->
+        </div>
+                    </div>
+                  </dl>
+                  </div>
+                </div>
+                <!-- MIN_VERSION -->
+              </div> <!-- /description -->
+            </div><div class="apiItem">
+              <a name="method-isWritableFileEntry"></a> <!-- method-anchor -->
+              <h4>isWritableFileEntry</h4>
+              <div class="summary">
+                  <!-- Note: intentionally longer 80 columns -->
+                  <span>chrome.fileSystem.isWritableFileEntry</span>(<span class="null"><span>FileEntry</span>
+                      <var><span>fileEntry</span></var></span><span class="null"><span>, </span><span>function</span>
+                      <var><span>IsWritableCallback</span></var></span>)</div>
+              <div class="description">
+                <p>Gets whether this FileEntry is writable or not.</p>
+                <!-- PARAMETERS -->
+                <h4>Parameters</h4>
+                <dl>
+                  <div>
+                    <div>
+          <dt>
+            <var>fileEntry</var>
+              <em>
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span id="typeTemplate">
+                      <span>
+                        <span>FileEntry</span>
+                      </span>
+                    </span>
+                  )
+                </div>
+              </em>
+          </dt>
+          <dd class="todo">
+            Undocumented.
+          </dd>
+          <!-- OBJECT PROPERTIES -->
+          <!-- OBJECT METHODS -->
+          <!-- OBJECT EVENT FIELDS -->
+          <!-- FUNCTION PARAMETERS -->
+        </div>
+                  </div><div>
+                    <div>
+          <dt>
+            <var>IsWritableCallback</var>
+              <em>
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span id="typeTemplate">
+                      <span>
+                        <span>function</span>
+                      </span>
+                    </span>
+                  )
+                </div>
+              </em>
+          </dt>
+          <dd class="todo">
+            Undocumented.
+          </dd>
+          <!-- OBJECT PROPERTIES -->
+          <!-- OBJECT METHODS -->
+          <!-- OBJECT EVENT FIELDS -->
+          <!-- FUNCTION PARAMETERS -->
+          <dd>
+            <div>
+          <h5>Parameters</h5>
+          <dl>
+            <div>
+              <div>
+          <dt>
+            <var>isWritable</var>
+              <em>
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span id="typeTemplate">
+                      <span>
+                        <span>boolean</span>
+                      </span>
+                    </span>
+                  )
+                </div>
+              </em>
+          </dt>
+          <dd class="todo">
+            Undocumented.
+          </dd>
+          <!-- OBJECT PROPERTIES -->
+          <!-- OBJECT METHODS -->
+          <!-- OBJECT EVENT FIELDS -->
+          <!-- FUNCTION PARAMETERS -->
+        </div>
+            </div>
+          </dl>
+        </div>
+          </dd>
+        </div>
+                  </div>
+                </dl>
+                <!-- RETURNS -->
+                <dl>
+                </dl>
+                <!-- CALLBACK -->
+                <div>
+                  <div>
+                  <h4>Callback function</h4>
+                  <p>
+                    The <em>callback</em> parameter should specify a function
+                    that looks like this:
+                  </p>
+                  <!-- Note: intentionally longer 80 columns -->
+                  <pre>function(<span>boolean isWritable</span>) <span class="subdued">{...}</span>;</pre>
+                  <dl>
+                    <div>
+                      <div>
+          <dt>
+            <var>isWritable</var>
+              <em>
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span id="typeTemplate">
+                      <span>
+                        <span>boolean</span>
                       </span>
                     </span>
                   )
diff --git a/chrome/common/extensions/docs/samples.json b/chrome/common/extensions/docs/samples.json
index 625f5f5a..ef822ee19 100644
--- a/chrome/common/extensions/docs/samples.json
+++ b/chrome/common/extensions/docs/samples.json
@@ -243,6 +243,7 @@
     "chrome.fileSystem.chooseFile": "fileSystem.html#method-chooseFile",
     "chrome.fileSystem.getDisplayPath": "fileSystem.html#method-getDisplayPath",
     "chrome.fileSystem.getWritableFileEntry": "fileSystem.html#method-getWritableFileEntry",
+    "chrome.fileSystem.isWritableFileEntry": "fileSystem.html#method-isWritableFileEntry",
     "chrome.history.addUrl": "history.html#method-addUrl",
     "chrome.history.deleteAll": "history.html#method-deleteAll",
     "chrome.history.deleteRange": "history.html#method-deleteRange",