Fix documentation for the buffer's saveAs method
authorPatrick Walton <pwalton@mozilla.com>
Mon, 20 Sep 2010 17:55:31 -0700
changeset 2040 7a747cc4d5899ea97c782bf2a6599ee66e73b842
parent 2039 5871e6a029afcf2f345a330fb5be7292aebb26f4
child 2041 46b17280cf9ef3c47d355bcd80669bf902bc8ecc
push id918
push userpwalton@mozilla.com
push dateTue, 21 Sep 2010 00:56:01 +0000
Fix documentation for the buffer's saveAs method
plugins/supported/text_editor/models/buffer.js
--- a/plugins/supported/text_editor/models/buffer.js
+++ b/plugins/supported/text_editor/models/buffer.js
@@ -137,18 +137,17 @@ exports.Buffer.prototype = {
     save: function() {
         return this._file.saveContents(this._model.value);
     },
 
     /**
      * Saves the contents of this buffer to a new file, and updates the file
      * field of this buffer to point to the result.
      *
-     * @param dir{Directory} The directory to save in.
-     * @param filename{string} The name of the file in the directory.
+     * @param {File} newFile The pathname to save to, as a File object.
      * @return A promise to return the newly-saved file.
      */
     saveAs: function(newFile) {
         var promise = new Promise();
 
         newFile.saveContents(this._model.value).then(function() {
             this._file = newFile;
             this._updateSyntaxManagerInitialContext();