| OLD | NEW |
|---|
| 1 <!doctype html> | 1 <!doctype html> |
| 2 <html> | 2 <html> |
| 3 <head> | 3 <head> |
| 4 <meta charset="UTF-8"/> | 4 <meta charset="UTF-8"/> |
| 5 <title>Analysis Server API Specification</title> | 5 <title>Analysis Server API Specification</title> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <h1>Analysis Server API Specification</h1> | 8 <h1>Analysis Server API Specification</h1> |
| 9 <h1 style="color:#999999">Version <version>1.17.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.17.0</version></h1> |
| 10 <p> | 10 <p> |
| (...skipping 130 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 141 <p> | 141 <p> |
| 142 To get an overview of the API, you can consult the <a href="#index">index<
/a>. | 142 To get an overview of the API, you can consult the <a href="#index">index<
/a>. |
| 143 </p> | 143 </p> |
| 144 <h3>Command-line Arguments</h3> | 144 <h3>Command-line Arguments</h3> |
| 145 <p> | 145 <p> |
| 146 The command-line arguments that can be passed to the server. | 146 The command-line arguments that can be passed to the server. |
| 147 </p> | 147 </p> |
| 148 <h4>Options</h4> | 148 <h4>Options</h4> |
| 149 <blockquote> | 149 <blockquote> |
| 150 <dl> | 150 <dl> |
| 151 <dt>--client-id</dt> |
| 152 <dd> |
| 153 <p> |
| 154 Specifies an identifier associated with the client. Used when |
| 155 generating error reports. |
| 156 </p> |
| 157 <p> |
| 158 Clients are strongly encouraged to provide this information in |
| 159 order to improve the quality of information that can be provided |
| 160 to them. |
| 161 </p> |
| 162 </dd> |
| 163 </dl> |
| 164 <dl> |
| 165 <dt>--client-version</dt> |
| 166 <dd> |
| 167 <p> |
| 168 Specifies the version of the client that is communicating with |
| 169 the server. Used when generating error reports. |
| 170 </p> |
| 171 <p> |
| 172 Clients are strongly encouraged to provide this information in |
| 173 order to improve the quality of information that can be provided |
| 174 to them. |
| 175 </p> |
| 176 </dd> |
| 177 </dl> |
| 178 <dl> |
| 151 <dt>--no-error-notification</dt> | 179 <dt>--no-error-notification</dt> |
| 152 <dd> | 180 <dd> |
| 153 Disable notifications about errors (see analysis.error). If this | 181 Disable notifications about errors (see analysis.error). If this |
| 154 flag is not specified then notifications will be sent for all | 182 flag is not specified then notifications will be sent for all |
| 155 errors produced for all files in the actual analysis roots. | 183 errors produced for all files in the actual analysis roots. |
| 156 </dd> | 184 </dd> |
| 157 </dl> | 185 </dl> |
| 158 <dl> | 186 <dl> |
| 159 <dt>--file-read-mode</dt> | |
| 160 <dd> | |
| 161 An enumeration of the ways files can be read from disk. Some clients | |
| 162 normalize end of line characters which would make the file offset and | |
| 163 range information incorrect. The default option is <tt>as-is</tt>, but | |
| 164 can also be set to <tt>normalize-eol-always</tt>. The default option | |
| 165 (<tt>as-is</tt>) reads files as they are on disk. The | |
| 166 <tt>normalize-eol-always</tt> option does the following: | |
| 167 <ul> | |
| 168 <li>'\r\n' is converted to '\n';</li> | |
| 169 <li>'\r' by itself is converted to '\n';</li> | |
| 170 <li>this happens regardless of the OS editor is running on.</li> | |
| 171 </ul> | |
| 172 </dd> | |
| 173 </dl> | |
| 174 <dl> | |
| 175 <dt>--no-index</dt> | 187 <dt>--no-index</dt> |
| 176 <dd> | 188 <dd> |
| 177 Disable the server from generating an index. If this flag is passed and an | 189 Disable the server from generating an index. If this flag is passed and an |
| 178 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED<
/tt>, | 190 API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED<
/tt>, |
| 179 will be thrown. The set of API calls that require an index include: | 191 will be thrown. The set of API calls that require an index include: |
| 180 refactoring calls, code completions and searching. | 192 refactoring calls, code completions and searching. |
| 181 <!-- TODO(jwren/scheglov): make sure that this of APIs that is complete. -
-> | 193 <!-- TODO(jwren/scheglov): make sure that this list of APIs that is comple
te. --> |
| 194 </dd> |
| 195 </dl> |
| 196 <dl> |
| 197 <dt>--file-read-mode</dt> |
| 198 <dd> |
| 199 <p><b>Deprecated</b></p> |
| 200 An enumeration of the ways files can be read from disk. Some clients |
| 201 normalize end of line characters which would make the file offset and |
| 202 range information incorrect. The default option is <tt>as-is</tt>, but |
| 203 can also be set to <tt>normalize-eol-always</tt>. The default option |
| 204 (<tt>as-is</tt>) reads files as they are on disk. The |
| 205 <tt>normalize-eol-always</tt> option does the following: |
| 206 <ul> |
| 207 <li>'\r\n' is converted to '\n';</li> |
| 208 <li>'\r' by itself is converted to '\n';</li> |
| 209 <li>this happens regardless of the OS editor is running on.</li> |
| 210 </ul> |
| 182 </dd> | 211 </dd> |
| 183 </dl> | 212 </dl> |
| 184 </blockquote> | 213 </blockquote> |
| 185 <domain name="server"> | 214 <domain name="server"> |
| 186 <p> | 215 <p> |
| 187 The server domain contains API’s related to the execution of | 216 The server domain contains API’s related to the execution of |
| 188 the server. | 217 the server. |
| 189 </p> | 218 </p> |
| 190 <request method="getVersion"> | 219 <request method="getVersion"> |
| 191 <p>Return the version number of the analysis server.</p> | 220 <p>Return the version number of the analysis server.</p> |
| (...skipping 4350 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 4542 This section contains a list of all of the errors that are | 4571 This section contains a list of all of the errors that are |
| 4543 produced by the server and the data that is returned with each. | 4572 produced by the server and the data that is returned with each. |
| 4544 </p> | 4573 </p> |
| 4545 <p> | 4574 <p> |
| 4546 TODO: TBD | 4575 TODO: TBD |
| 4547 </p> | 4576 </p> |
| 4548 <h2 class="domain"><a name="index">Index</a></h2> | 4577 <h2 class="domain"><a name="index">Index</a></h2> |
| 4549 <index></index> | 4578 <index></index> |
| 4550 </body> | 4579 </body> |
| 4551 </html> | 4580 </html> |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2397293002:
Improve server documentation (issue 27521) (Closed)
