jyapayne/ace
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc fixes

Browse source
This commit is contained in:
Garen Torikian 2012-12-12 15:59:26 -08:00 • committed by nightwing
commit aca8e88137
8 changed files with 28 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

2
lib/ace/document.js
View file

@ -169,7 +169,7 @@ var Document = function(text) {
/**
* [Returns the type of newlines being used; either `windows`, `unix`, or `auto`]{: #Document.getNewLineMode}
* @returns String
* @returns {String}
**/
this.getNewLineMode = function() {
return this.$newLineMode;

16
lib/ace/edit_session.js
View file

@ -630,7 +630,7 @@ var EditSession = function(text, mode) {
* @param {Boolean} inFront Set to `true` to establish a front marker
*
*
* @return Number
* @return {Number}
**/
this.addMarker = function(range, clazz, type, inFront) {
var id = this.$markerId++;
@ -661,7 +661,7 @@ var EditSession = function(text, mode) {
* @param {Boolean} inFront Set to `true` to establish a front marker
*
*
* @return Object The added marker
* @return {Object} The added marker
**/
this.addDynamicMarker = function(marker, inFront) {
if (!marker.update)
@ -830,7 +830,7 @@ var EditSession = function(text, mode) {
* @param {Number} row The row number to start from
* @param {Number} column The column number to start from
*
* @return Range
* @return {Range}
**/
this.getAWordRange = function(row, column) {
var wordRange = this.getWordRange(row, column);
@ -856,7 +856,7 @@ var EditSession = function(text, mode) {
/**
*
* Returns the current new line mode.
* @returns String
* @returns {String}
* @related Document.getNewLineMode
**/
this.getNewLineMode = function() {
@ -1139,7 +1139,7 @@ var EditSession = function(text, mode) {
* {:Document.getTextRange.desc}
* @param {Range} range The range to work with
*
* @returns {Range}
* @returns {String}
**/
this.getTextRange = function(range) {
return this.doc.getTextRange(range || this.selection.getRange());
@ -2037,8 +2037,8 @@ var EditSession = function(text, mode) {
/**
* Returns the position (on screen) for the last character in the provided screen row.
* @param {Number} screenRow The screen row to check
*
*
* @returns {Number}
*
* @related EditSession.documentToScreenColumn
**/
this.getScreenLastRowColumn = function(screenRow) {
@ -2298,7 +2298,7 @@ var EditSession = function(text, mode) {
* For the given document row and column, returns the screen column.
* @param {Number} row
* @param {Number} docColumn
*
* @returns {Number}
*
**/
this.documentToScreenColumn = function(row, docColumn) {

9
lib/ace/editor.js
View file

@ -389,7 +389,7 @@ var Editor = function(renderer, session) {
/**
* Returns `true` if the current `textInput` is in focus.
* @return Boolean
* @return {Boolean}
**/
this.isFocused = function() {
return this.textInput.isFocused();
@ -895,7 +895,7 @@ var Editor = function(renderer, session) {
/**
* Returns `true` if current lines are always highlighted.
* @return Boolean
* @return {Boolean}
**/
this.getHighlightActiveLine = function() {
return this.$highlightActiveLine;
@ -1085,7 +1085,7 @@ var Editor = function(renderer, session) {
/**
* Returns `true` if the fold widgets are shown.
* @return Boolean
* @return {Boolean}
**/
this.getShowFoldWidgets = function() {
return this.renderer.$gutterLayer.getShowFoldWidgets();
@ -1344,10 +1344,9 @@ var Editor = function(renderer, session) {
};
/**
* Editor.modifyNumber(amount)
* If the character before the cursor is a number, this functions changes its value by `amount`.
* @param {Number} amount The value to change the numeral by (can be negative to decrease value)
*
* If the character before the cursor is a number, this functions changes its value by `amount`.
**/
this.modifyNumber = function(amount) {
var row = this.selection.getCursor().row;

2
lib/ace/keyboard/state_handler.js
View file

@ -223,7 +223,7 @@ StateHandler.prototype = {
* This is a useful matching function and therefore is defined here so that
* users of KeyboardStateMapper can use it.
*
* @return boolean
* @return {Boolean}
* If no command key (Command|Option|Shift|Ctrl) is pressed, it
* returns true. If the only the Shift key is pressed + a character
* true is returned as well. Otherwise, false is returned.

4
lib/ace/mode/css/csslint.js
View file

@ -6368,7 +6368,7 @@ var CSSLint = (function(){
/**
* Returns the rule objects.
* @return An array of rule objects.
* @return {Array} An array of rule objects.
* @method getRules
*/
api.getRules = function(){
@ -6379,7 +6379,7 @@ var CSSLint = (function(){
/**
* Returns a ruleset configuration object with all current rules.
* @return A ruleset object.
* @return {Object} A ruleset object.
* @method getRuleset
*/
api.getRuleset = function() {

14
lib/ace/multi_select.js
View file

@ -188,7 +188,7 @@ var EditSession = require("./edit_session").EditSession;
/**
* Returns a concatenation of all the ranges.
* @returns Array
* @returns {Array}
* @method Selection.getAllRanges
**/
this.getAllRanges = function() {
@ -267,7 +267,7 @@ var EditSession = require("./edit_session").EditSession;
* @param {Cursor} screenCursor The cursor to use
* @param {Anchor} screenAnchor The anchor to use
* @param {Boolean} includeEmptyLines If true, this includes ranges inside the block which are empty due to clipping
* @returns Range
* @returns {Range}
* @method Selection.rectangularRangeBlock
**/
this.rectangularRangeBlock = function(screenCursor, screenAnchor, includeEmptyLines) {
@ -353,7 +353,7 @@ var Editor = require("./editor").Editor;
/**
* Adds the selection and cursor.
* @param {Range} orientedRange A range containing a cursor
* @returns Range
* @returns {Range}
* @method Editor.addSelectionMarker
**/
this.addSelectionMarker = function(orientedRange) {
@ -543,10 +543,10 @@ var Editor = require("./editor").Editor;
/**
* Finds and selects all the occurences of `needle`.
* @param {String} The text to find
* @param {Object} The search options
* @param {Boolean} keeps
* @returns Number
* @param {String} needle The text to find
* @param {Object} options The search options
* @param {Boolean} additive Keeps
* @returns {Number}
* @method Editor.findAll
**/
this.findAll = function(needle, options, additive) {

6
lib/ace/range.js
View file

@ -62,11 +62,11 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
(function() {
/**
* Returns `true` if and only if the starting row and column, and ending tow and column, are equivalent to those given by `range`.
* Returns `true` if and only if the starting row and column, and ending row and column, are equivalent to those given by `range`.
* @param {Range} range A range to check against
*
*
* @return Boolean
* @return {Boolean}
**/
this.isEqual = function(range) {
return this.start.row == range.start.row &&
@ -81,7 +81,7 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
* ```
* [start.row/start.column] -> [end.row/end.column]
* ```
* @return String
* @return {String}
**/
this.toString = function() {
return ("Range: [" + this.start.row + "/" + this.start.column +

4
lib/ace/split.js
View file

@ -277,7 +277,7 @@ var Split = function(container, theme, splits) {
/**
*
* Returns the orientation.
* @returns Number
* @returns {Number}
**/
this.getOrientation = function() {
return this.$orientation;
@ -285,9 +285,9 @@ var Split = function(container, theme, splits) {
/**
*
* Sets the orientation.
* @param {Number} orientation The new orientation value
*
* Sets the orientation.
*
**/
this.setOrientation = function(orientation) {