From eba2abd5d94797611fbb898889fd7f55f02564ab Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Thu, 13 Mar 2014 09:19:51 -0700 Subject: [PATCH] :memo: Doc save, saveAs, and getPath as public --- src/editor.coffee | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/editor.coffee b/src/editor.coffee index 473308d73..1d7c6dde5 100644 --- a/src/editor.coffee +++ b/src/editor.coffee @@ -404,13 +404,19 @@ class Editor extends Model else _.multiplyString("\t", Math.floor(number)) - # {Delegates to: TextBuffer.save} + # Public: Saves the editor's text buffer. + # + # See {TextBuffer::save} for more details. save: -> @buffer.save() - # {Delegates to: TextBuffer.saveAs} - saveAs: (path) -> @buffer.saveAs(path) + # Public: Saves the editor's text buffer as the given path. + # + # See {TextBuffer::saveAs} for more details. + # + # filePath - A {String} path. + saveAs: (filePath) -> @buffer.saveAs(filePath) - # {Delegates to: TextBuffer.getPath} + # Public: Returns the {String} path of this editor's text buffer. getPath: -> @buffer.getPath() # Public: Returns a {String} representing the entire contents of the editor.