|
63 | 63 | * |
64 | 64 | * A code hint provider should implement the following three functions: |
65 | 65 | * |
66 | | - * - `CodeHintProvider.hasHints('editor', 'implicitChar')` |
67 | | - * - `CodeHintProvider.getHints('implicitChar')` |
68 | | - * - `CodeHintProvider.insertHint('hint')` |
| 66 | + * ```js |
| 67 | + * - `CodeHintProvider.hasHints(editor, implicitChar)` |
| 68 | + * - `CodeHintProvider.getHints(implicitChar)` |
| 69 | + * - `CodeHintProvider.insertHint(hint)` |
| 70 | + * ``` |
69 | 71 | * |
70 | 72 | * The behavior of these three functions is described in detail below. |
71 | 73 | * |
72 | | - * __CodeHintProvider.hasHints('editor', 'implicitChar')__ |
| 74 | + * ```js |
| 75 | + * __CodeHintProvider.hasHints(editor, implicitChar)__ |
| 76 | + * ``` |
73 | 77 | * |
74 | 78 | * The method by which a provider indicates intent to provide hints for a |
75 | 79 | * given editor. The manager calls this method both when hints are |
|
99 | 103 | * particular, it should keep a reference to the editor object so that it |
100 | 104 | * can access the editor in future calls to getHints and insertHints. |
101 | 105 | * |
102 | | - * param {'Editor'} editor |
| 106 | + * ```js |
| 107 | + * param {Editor} editor |
| 108 | + * ``` |
103 | 109 | * A non-null editor object for the active window. |
104 | 110 | * |
105 | 111 | * param {String} implicitChar |
|
113 | 119 | * whether it is appropriate to do so. |
114 | 120 | * |
115 | 121 | * |
116 | | - * __CodeHintProvider.getHints('implicitChar')__ |
| 122 | + * ```js |
| 123 | + * __CodeHintProvider.getHints(implicitChar)__ |
| 124 | + * ``` |
117 | 125 | * |
118 | 126 | * The method by which a provider provides hints for the editor context |
119 | 127 | * associated with the current session. The getHints method is called only |
|
198 | 206 | * of prefix matching, or can provide its own emphasis if it wishes to use |
199 | 207 | * a more sophisticated matching algorithm. |
200 | 208 | * |
201 | | - * |
202 | | - * __CodeHintProvider.insertHint('hint')__ |
| 209 | + * ```js |
| 210 | + * __CodeHintProvider.insertHint(hint)__ |
| 211 | + * ``` |
203 | 212 | * |
204 | 213 | * The method by which a provider inserts a hint into the editor context |
205 | 214 | * associated with the current session. The provider may assume that the |
|
0 commit comments