Skip to content

Commit c5ae1a4

Browse files
committed
docs: update docs, after build fail issue fix
1 parent 827b227 commit c5ae1a4

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/API-Reference/editor/CodeHintManager.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,11 +156,13 @@ param {string} implicitChar
156156
Either null, if the request to update the hint list was a result of
157157
navigation, or a single character that represents the last insertion.
158158

159+
```js
159160
return {jQuery.Deferred|{
160161
hints: Array.<string|jQueryObject>,
161162
match: string,
162163
selectInitial: boolean,
163164
handleWideResults: boolean}}
165+
```
164166

165167
Null if the provider wishes to end the hinting session. Otherwise, a
166168
response object, possibly deferred, that provides 1. a sorted array

docs/API-Reference/editor/Editor.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ const Editor = brackets.getModule("editor/Editor")
4747
* [.charCoords(pos, [mode])](#Editor+charCoords) ⇒ <code>Object</code>
4848
* [.getToken([cursor], [precise])](#Editor+getToken) ⇒ <code>Object</code>
4949
* [.getCharacterAtPosition(pos)](#Editor+getCharacterAtPosition) ⇒ <code>string</code> \| <code>null</code>
50+
* [.getLine(lineNumber)](#Editor+getLine) ⇒ <code>string</code> \| <code>null</code>
5051
* [.getPrevCharacterAtPosition(pos)](#Editor+getPrevCharacterAtPosition) ⇒ <code>string</code> \| <code>null</code>
5152
* [.getNextToken([cursor], [skipWhitespace], [precise])](#Editor+getNextToken) ⇒ <code>Object</code>
5253
* [.getPreviousToken([cursor], [skipWhitespace], [precise])](#Editor+getPreviousToken) ⇒ <code>Object</code>
@@ -554,6 +555,19 @@ x|y where `|` is the cursor, will return y
554555
| --- | --- | --- |
555556
| pos | <code>CodeMirror.Position</code> | The position from which to retrieve the character. This should be an object with `line` and `ch` properties. |
556557

558+
<a name="Editor+getLine"></a>
559+
560+
### editor.getLine(lineNumber) ⇒ <code>string</code> \| <code>null</code>
561+
Retrieves a single line text
562+
563+
**Kind**: instance method of [<code>Editor</code>](#Editor)
564+
**Returns**: <code>string</code> \| <code>null</code> - The text at the given position if within bounds,
565+
otherwise `null` if the position is out of range.
566+
567+
| Param | Type | Description |
568+
| --- | --- | --- |
569+
| lineNumber | <code>number</code> | The lineNumber to extract text from |
570+
557571
<a name="Editor+getPrevCharacterAtPosition"></a>
558572

559573
### editor.getPrevCharacterAtPosition(pos) ⇒ <code>string</code> \| <code>null</code>

0 commit comments

Comments
 (0)