Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(182)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: pkg/analyzer_plugin/doc/api.html

Issue 2994103002: Add kythe support to plugins and format the spec files (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « pkg/analysis_server/tool/spec/spec_input.html ('k') | pkg/analyzer_plugin/lib/protocol/protocol_common.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><html><head> 1 <!DOCTYPE html><html><head>
2 <meta charset="UTF-8"> 2 <meta charset="UTF-8">
3 <title>Analysis Server Plugin API Specification</title> 3 <title>Analysis Server Plugin API Specification</title>
4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code +Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { 4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Code +Pro|Roboto:500,400italic,300,400" type="text/css"><style>body {
5 font-family: 'Roboto', sans-serif; 5 font-family: 'Roboto', sans-serif;
6 max-width: 800px; 6 max-width: 800px;
7 margin: 0 auto; 7 margin: 0 auto;
8 padding: 0 16px; 8 padding: 0 16px;
9 font-size: 16px; 9 font-size: 16px;
10 line-height: 1.5; 10 line-height: 1.5;
(...skipping 807 matching lines...) Expand 10 before | Expand all | Expand 10 after
818 <p> 818 <p>
819 The offset used to select the errors for which fixes will be returned. 819 The offset used to select the errors for which fixes will be returned.
820 </p> 820 </p>
821 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes: List&lt;<a href ="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>&gt;</b></dt><dd> 821 </dd></dl><h4>returns:</h4><dl><dt class="field"><b>fixes: List&lt;<a href ="#type_AnalysisErrorFixes">AnalysisErrorFixes</a>&gt;</b></dt><dd>
822 822
823 <p> 823 <p>
824 The fixes that are available for the errors at the given offset. 824 The fixes that are available for the errors at the given offset.
825 </p> 825 </p>
826 </dd></dl></dd></dl> 826 </dd></dl></dd></dl>
827 827
828
828 <h2 class="domain"><a name="types">Types</a></h2> 829 <h2 class="domain"><a name="types">Types</a></h2>
829 <p> 830 <p>
830 This section contains descriptions of the data types referenced in the API’s 831 This section contains descriptions of the data types referenced in the API’s
831 of the various domains. 832 of the various domains.
832 </p> 833 </p>
833 834
834 835
835 836
836 837
837 838
(...skipping 621 matching lines...) Expand 10 before | Expand all | Expand 10 after
1459 <p>Only for version 2 of highlight.</p> 1460 <p>Only for version 2 of highlight.</p>
1460 </dd><dt class="value">TOP_LEVEL_VARIABLE_DECLARATION</dt><dd> 1461 </dd><dt class="value">TOP_LEVEL_VARIABLE_DECLARATION</dt><dd>
1461 1462
1462 <p>Only for version 2 of highlight.</p> 1463 <p>Only for version 2 of highlight.</p>
1463 </dd><dt class="value">TYPE_NAME_DYNAMIC</dt><dt class="value">TYPE_PARAME TER</dt><dt class="value">UNRESOLVED_INSTANCE_MEMBER_REFERENCE</dt><dd> 1464 </dd><dt class="value">TYPE_NAME_DYNAMIC</dt><dt class="value">TYPE_PARAME TER</dt><dt class="value">UNRESOLVED_INSTANCE_MEMBER_REFERENCE</dt><dd>
1464 1465
1465 <p>Only for version 2 of highlight.</p> 1466 <p>Only for version 2 of highlight.</p>
1466 </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd> 1467 </dd><dt class="value">VALID_STRING_ESCAPE</dt><dd>
1467 1468
1468 <p>Only for version 2 of highlight.</p> 1469 <p>Only for version 2 of highlight.</p>
1470 </dd></dl></dd><dt class="typeDefinition"><a name="type_KytheEntry">KytheE ntry: object</a></dt><dd>
1471 <p>
1472 This object matches the format and documentation of the Entry object
1473 documented in the
1474 <a href="https://kythe.io/docs/kythe-storage.html#_entry">Kythe Storage
1475 Model</a>.
1476 </p>
1477
1478 <dl><dt class="field"><b>source: <a href="#type_KytheVName">KytheVName</a></b> </dt><dd>
1479
1480 <p>
1481 The ticket of the source node (must not be empty).
1482 </p>
1483 </dd><dt class="field"><b>kind: String</b></dt><dd>
1484
1485 <p>
1486 An edge label (may be empty). The schema defines which labels are
1487 meaningful.
1488 </p>
1489 </dd><dt class="field"><b>target: <a href="#type_KytheVName">KytheVName</a ></b></dt><dd>
1490
1491 <p>
1492 The ticket of the target node (may be empty).
1493 </p>
1494 </dd><dt class="field"><b>fact: String</b></dt><dd>
1495
1496 <p>
1497 A fact label (must not be empty). The schema defines which fact labels
1498 are meaningful.
1499 </p>
1500 </dd><dt class="field"><b>value: List&lt;int&gt;</b></dt><dd>
1501
1502 <p>
1503 The <tt>String</tt> value of the fact (may be empty).
1504 </p>
1505 </dd></dl></dd><dt class="typeDefinition"><a name="type_KytheVName">KytheV Name: object</a></dt><dd>
1506 <p>
1507 This object matches the format and documentation of the Vector-Name object
1508 documented in the
1509 <a href="https://kythe.io/docs/kythe-storage.html#_a_id_termvname_a_vector _name_strong_vname_strong">Kythe
1510 Storage Model</a>.
1511 </p>
1512
1513 <dl><dt class="field"><b>signature: String</b></dt><dd>
1514
1515 <p>
1516 An opaque signature generated by the analyzer.
1517 </p>
1518 </dd><dt class="field"><b>corpus: String</b></dt><dd>
1519
1520 <p>
1521 The corpus of source code this <tt>KytheVName</tt> belongs to.
1522 Loosely, a corpus is a collection of related files, such as the
1523 contents of a given source repository.
1524 </p>
1525 </dd><dt class="field"><b>root: String</b></dt><dd>
1526
1527 <p>
1528 A corpus-specific root label, typically a directory path or project
1529 identifier, denoting a distinct subset of the corpus. This may also be
1530 used to designate virtual collections like generated files.
1531 </p>
1532 </dd><dt class="field"><b>path: String</b></dt><dd>
1533
1534 <p>
1535 A path-structured label describing the “location” of the named object
1536 relative to the corpus and the root.
1537 </p>
1538 </dd><dt class="field"><b>language: String</b></dt><dd>
1539
1540 <p>
1541 The language this name belongs to.
1542 </p>
1469 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGroup">L inkedEditGroup: object</a></dt><dd> 1543 </dd></dl></dd><dt class="typeDefinition"><a name="type_LinkedEditGroup">L inkedEditGroup: object</a></dt><dd>
1470 <p> 1544 <p>
1471 A collection of positions that should be linked (edited simultaneously) 1545 A collection of positions that should be linked (edited simultaneously)
1472 for the purposes of updating code after a source change. For example, if a 1546 for the purposes of updating code after a source change. For example, if a
1473 set of edits introduced a new variable name, the group would contain all 1547 set of edits introduced a new variable name, the group would contain all
1474 of the positions of the variable name so that if the client wanted to let 1548 of the positions of the variable name so that if the client wanted to let
1475 the user edit the variable name after the operation, all occurrences of 1549 the user edit the variable name after the operation, all occurrences of
1476 the name could be edited simultaneously. 1550 the name could be edited simultaneously.
1477 </p> 1551 </p>
1478 1552
(...skipping 824 matching lines...) Expand 10 before | Expand all | Expand 10 after
2303 <p> 2377 <p>
2304 The old name of the element before the refactoring. 2378 The old name of the element before the refactoring.
2305 </p> 2379 </p>
2306 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName: String</b></d t><dd> 2380 </dd></dl><h4>Options:</h4><dl><dt class="field"><b>newName: String</b></d t><dd>
2307 2381
2308 <p> 2382 <p>
2309 The name that the element should have after the refactoring. 2383 The name that the element should have after the refactoring.
2310 </p> 2384 </p>
2311 </dd></dl></dd></dl> 2385 </dd></dl></dd></dl>
2312 <h2 class="domain"><a name="index">Index</a></h2> 2386 <h2 class="domain"><a name="index">Index</a></h2>
2313 <h3>Domains</h3><h4>plugin (<a href="#domain_plugin">↑</a>)</h4><div class="subi ndex"><h5>Requests</h5><ul><li><a href="#request_plugin.versionCheck">versionChe ck</a></li><li><a href="#request_plugin.shutdown">shutdown</a></li></ul><h5>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_plugin.error" >error</a></li></ul></div></div><h4>analysis (<a href="#domain_analysis">↑</a>)< /h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.ge tNavigation">getNavigation</a></li><li><a href="#request_analysis.handleWatchEve nts">handleWatchEvents</a></li><li><a href="#request_analysis.setContextRoots">s etContextRoots</a></li><li><a href="#request_analysis.setPriorityFiles">setPrior ityFiles</a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptio ns</a></li><li><a href="#request_analysis.updateContent">updateContent</a></li>< /ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_a nalysis.errors">errors</a></li><li><a href="#notification_analysis.folding">fold ing</a></li><li><a href="#notification_analysis.highlights">highlights</a></li>< li><a href="#notification_analysis.navigation">navigation</a></li><li><a href="# notification_analysis.occurrences">occurrences</a></li><li><a href="#notificatio n_analysis.outline">outline</a></li></ul></div></div><h4>completion (<a href="#d omain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a h ref="#request_completion.getSuggestions">getSuggestions</a></li></ul></div><h4>e dit (<a href="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5><u l><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reques t_edit.getFixes">getFixes</a></li></ul></div><h3>Types (<a href="#types">↑</a>)< /h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOv erlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a hre f="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Analy sisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisError Type">AnalysisErrorType</a></li><li><a href="#type_AnalysisService">AnalysisServ ice</a></li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></l i><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a h ref="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a hre f="#type_ContextRoot">ContextRoot</a></li><li><a href="#type_Element">Element</a ></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a href="#type_Fil ePath">FilePath</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li> <a href="#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_Highlight Region">HighlightRegion</a></li><li><a href="#type_HighlightRegionType">Highligh tRegionType</a></li><li><a href="#type_LinkedEditGroup">LinkedEditGroup</a></li> <li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a></li><li><a hre f="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a></li><li><a href= "#type_Location">Location</a></li><li><a href="#type_NavigationRegion">Navigatio nRegion</a></li><li><a href="#type_NavigationTarget">NavigationTarget</a></li><l i><a href="#type_Occurrences">Occurrences</a></li><li><a href="#type_Outline">Ou tline</a></li><li><a href="#type_Position">Position</a></li><li><a href="#type_P rioritizedSourceChange">PrioritizedSourceChange</a></li><li><a href="#type_Refac toringKind">RefactoringKind</a></li><li><a href="#type_RefactoringMethodParamete r">RefactoringMethodParameter</a></li><li><a href="#type_RefactoringMethodParame terKind">RefactoringMethodParameterKind</a></li><li><a href="#type_RefactoringPr oblem">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity" >RefactoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">Rem oveContentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li> <li><a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type _SourceChange">SourceChange</a></li><li><a href="#type_SourceEdit">SourceEdit</a ></li><li><a href="#type_SourceFileEdit">SourceFileEdit</a></li><li><a href="#ty pe_WatchEvent">WatchEvent</a></li><li><a href="#type_WatchEventType">WatchEventT ype</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3><div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CONVER T_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTER">C ONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARIABLE ">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">EXTRA CT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LOCAL_ VARIABLE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHOD</a></li> <li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#refactoring _RENAME">RENAME</a></li></ul></div> 2387 <h3>Domains</h3><h4>plugin (<a href="#domain_plugin">↑</a>)</h4><div class="subi ndex"><h5>Requests</h5><ul><li><a href="#request_plugin.versionCheck">versionChe ck</a></li><li><a href="#request_plugin.shutdown">shutdown</a></li></ul><h5>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_plugin.error" >error</a></li></ul></div></div><h4>analysis (<a href="#domain_analysis">↑</a>)< /h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_analysis.ge tNavigation">getNavigation</a></li><li><a href="#request_analysis.handleWatchEve nts">handleWatchEvents</a></li><li><a href="#request_analysis.setContextRoots">s etContextRoots</a></li><li><a href="#request_analysis.setPriorityFiles">setPrior ityFiles</a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptio ns</a></li><li><a href="#request_analysis.updateContent">updateContent</a></li>< /ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_a nalysis.errors">errors</a></li><li><a href="#notification_analysis.folding">fold ing</a></li><li><a href="#notification_analysis.highlights">highlights</a></li>< li><a href="#notification_analysis.navigation">navigation</a></li><li><a href="# notification_analysis.occurrences">occurrences</a></li><li><a href="#notificatio n_analysis.outline">outline</a></li></ul></div></div><h4>completion (<a href="#d omain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a h ref="#request_completion.getSuggestions">getSuggestions</a></li></ul></div><h4>e dit (<a href="#domain_edit">↑</a>)</h4><div class="subindex"><h5>Requests</h5><u l><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reques t_edit.getFixes">getFixes</a></li></ul></div><h3>Types (<a href="#types">↑</a>)< /h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOv erlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a hre f="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Analy sisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisError Type">AnalysisErrorType</a></li><li><a href="#type_AnalysisService">AnalysisServ ice</a></li><li><a href="#type_ChangeContentOverlay">ChangeContentOverlay</a></l i><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a h ref="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a hre f="#type_ContextRoot">ContextRoot</a></li><li><a href="#type_Element">Element</a ></li><li><a href="#type_ElementKind">ElementKind</a></li><li><a href="#type_Fil ePath">FilePath</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li> <a href="#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_Highlight Region">HighlightRegion</a></li><li><a href="#type_HighlightRegionType">Highligh tRegionType</a></li><li><a href="#type_KytheEntry">KytheEntry</a></li><li><a hre f="#type_KytheVName">KytheVName</a></li><li><a href="#type_LinkedEditGroup">Link edEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestio n</a></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind< /a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_Navigat ionRegion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">Navigat ionTarget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a hre f="#type_Outline">Outline</a></li><li><a href="#type_Position">Position</a></li> <li><a href="#type_PrioritizedSourceChange">PrioritizedSourceChange</a></li><li> <a href="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Refac toringMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_Ref actoringMethodParameterKind">RefactoringMethodParameterKind</a></li><li><a href= "#type_RefactoringProblem">RefactoringProblem</a></li><li><a href="#type_Refacto ringProblemSeverity">RefactoringProblemSeverity</a></li><li><a href="#type_Remov eContentOverlay">RemoveContentOverlay</a></li><li><a href="#type_RequestError">R equestError</a></li><li><a href="#type_RequestErrorCode">RequestErrorCode</a></l i><li><a href="#type_SourceChange">SourceChange</a></li><li><a href="#type_Sourc eEdit">SourceEdit</a></li><li><a href="#type_SourceFileEdit">SourceFileEdit</a>< /li><li><a href="#type_WatchEvent">WatchEvent</a></li><li><a href="#type_WatchEv entType">WatchEventType</a></li></ul></div><h3>Refactorings (<a href="#refactori ngs">↑</a>)</h3><div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETT ER_TO_METHOD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT _METHOD_TO_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EX TRACT_LOCAL_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_E XTRACT_METHOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VAR IABLE">INLINE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_METHOD">IN LINE_METHOD</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li>< a href="#refactoring_RENAME">RENAME</a></li></ul></div>
2314 2388
2315 2389
2316 </body></html> 2390 </body></html>
OLDNEW
« no previous file with comments | « pkg/analysis_server/tool/spec/spec_input.html ('k') | pkg/analyzer_plugin/lib/protocol/protocol_common.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698