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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 1416093007: Experimental `getDiagnostics` request (#24480). (Closed) Base URL: git@github.com:dart-lang/sdk.git@master
Patch Set: Review fixes. Created 5 years, 1 month 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 | « no previous file | pkg/analysis_server/lib/plugin/protocol/generated_protocol.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 API Specification</title> 3 <title>Analysis Server API Specification</title>
4 <style>body { 4 <style>body {
5 font-family: sans-serif, serif; 5 font-family: sans-serif, serif;
6 padding-left: 5%; 6 padding-left: 5%;
7 padding-right: 5%; 7 padding-right: 5%;
8 } 8 }
9 h1 { 9 h1 {
10 text-align: center; 10 text-align: center;
(...skipping 2246 matching lines...) Expand 10 before | Expand all | Expand 10 after
2257 is not a Dart file. 2257 is not a Dart file.
2258 </p> 2258 </p>
2259 </dd><dt class="field"><b><i>referencedFiles ( <span style="color:#999 999">optional</span> List&lt;<a href="#type_FilePath">FilePath</a>&gt; )</i></b> </dt><dd> 2259 </dd><dt class="field"><b><i>referencedFiles ( <span style="color:#999 999">optional</span> List&lt;<a href="#type_FilePath">FilePath</a>&gt; )</i></b> </dt><dd>
2260 2260
2261 <p> 2261 <p>
2262 A list of the Dart files that are referenced by the file. This 2262 A list of the Dart files that are referenced by the file. This
2263 field is omitted if the file is not an HTML file. 2263 field is omitted if the file is not an HTML file.
2264 </p> 2264 </p>
2265 </dd></dl></dd></dl> 2265 </dd></dl></dd></dl>
2266 2266
2267
2267 <h2 class="domain"><a name="types">Types</a></h2> 2268 <h2 class="domain"><a name="types">Types</a></h2>
2268 <p> 2269 <p>
2269 This section contains descriptions of the data types referenced 2270 This section contains descriptions of the data types referenced
2270 in the API’s of the various domains. 2271 in the API’s of the various domains.
2271 </p> 2272 </p>
2272 2273
2273 2274
2274 2275
2275 2276
2276 2277
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after
2320 2321
2321 2322
2322 2323
2323 2324
2324 2325
2325 2326
2326 2327
2327 2328
2328 2329
2329 2330
2331
2330 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd> 2332 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd>
2331 <p> 2333 <p>
2332 A directive to begin overlaying the contents of a file. The 2334 A directive to begin overlaying the contents of a file. The
2333 supplied content will be used for analysis in place of the 2335 supplied content will be used for analysis in place of the
2334 file contents in the filesystem. 2336 file contents in the filesystem.
2335 </p> 2337 </p>
2336 <p> 2338 <p>
2337 If this directive is used on a file that already has a file 2339 If this directive is used on a file that already has a file
2338 content overlay, the old overlay is discarded and replaced 2340 content overlay, the old overlay is discarded and replaced
2339 with the new one. 2341 with the new one.
(...skipping 1908 matching lines...) Expand 10 before | Expand all | Expand 10 after
4248 produced by the server and the data that is returned with each. 4250 produced by the server and the data that is returned with each.
4249 </p> 4251 </p>
4250 <p> 4252 <p>
4251 TBD 4253 TBD
4252 </p> 4254 </p>
4253 <h2 class="domain"><a name="index">Index</a></h2> 4255 <h2 class="domain"><a name="index">Index</a></h2>
4254 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class=" subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href=" #request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre f="#notification_server.status">status</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.getErrors">getErrors</a></li><li><a href="#request _analysis.getHover">getHover</a></li><li><a href="#request_analysis.getLibraryDe pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a> </li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript ions</a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</ a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li ><li><a href="#request_analysis.updateContent">updateContent</a></li><li><a href ="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications< /h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles" >analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></l i><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a href="#notification_analysis.folding">folding</a></li><li><a href="#notification _analysis.highlights">highlights</a></li><li><a href="#notification_analysis.imp lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in validate</a></li><li><a href="#notification_analysis.navigation">navigation</a>< /li><li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a href="#notification_analysis.outline">outline</a></li><li><a href="#notification _analysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href= "#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li>< a href="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re sults">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</ a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search. findElementReferences">findElementReferences</a></li><li><a href="#request_searc h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r equest_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications< /h5><div class="subindex"><ul><li><a href="#notification_search.results">results </a></li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class ="subindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></ li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reque st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href=" #request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori ng">getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</ a></li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li ></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="su bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</ a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications< /h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l aunchData</a></li></ul></div></div><h3>Types (<a href="#types">↑</a>)</h3><div c lass="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a>< /li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_A nalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSe verity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">Anal ysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOptions</a></l i><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type _AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContentOverlay" >ChangeContentOverlay</a></li><li><a href="#type_CompletionId">CompletionId</a>< /li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a h ref="#type_Element">Element</a></li><li><a href="#type_ElementKind">ElementKind< /a></li><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li><a href="# type_ExecutableKind">ExecutableKind</a></li><li><a href="#type_ExecutionContextI d">ExecutionContextId</a></li><li><a href="#type_ExecutionService">ExecutionServ ice</a></li><li><a href="#type_FileKind">FileKind</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_GeneralAn alysisService">GeneralAnalysisService</a></li><li><a href="#type_HighlightRegion ">HighlightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegio nType</a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li> <a href="#type_ImplementedClass">ImplementedClass</a></li><li><a href="#type_Imp lementedMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">Li nkedEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggest ion</a></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKin d</a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_Navig ationRegion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">Navig ationTarget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a h ref="#type_Outline">Outline</a></li><li><a href="#type_Override">Override</a></l i><li><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#ty pe_Position">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><l i><a href="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Ref actoringMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_R efactoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOp tions">RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterK ind">RefactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProble m">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Ref actoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveC ontentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li> <a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_Sea rchId">SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><l i><a href="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_S erverService">ServerService</a></li><li><a href="#type_SourceChange">SourceChang e</a></li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_S ourceFileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">Type HierarchyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a> )</h3><div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METH OD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO _GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCA L_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_MET HOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INL INE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHO D</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#r efactoring_RENAME">RENAME</a></li></ul></div> 4256 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class=" subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href=" #request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre f="#notification_server.status">status</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.getErrors">getErrors</a></li><li><a href="#request _analysis.getHover">getHover</a></li><li><a href="#request_analysis.getLibraryDe pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a> </li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript ions</a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</ a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li ><li><a href="#request_analysis.updateContent">updateContent</a></li><li><a href ="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications< /h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles" >analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></l i><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a href="#notification_analysis.folding">folding</a></li><li><a href="#notification _analysis.highlights">highlights</a></li><li><a href="#notification_analysis.imp lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in validate</a></li><li><a href="#notification_analysis.navigation">navigation</a>< /li><li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a href="#notification_analysis.outline">outline</a></li><li><a href="#notification _analysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href= "#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li>< a href="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Noti fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re sults">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</ a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search. findElementReferences">findElementReferences</a></li><li><a href="#request_searc h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r equest_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications< /h5><div class="subindex"><ul><li><a href="#notification_search.results">results </a></li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class ="subindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></ li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reque st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href=" #request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori ng">getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</ a></li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li ></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="su bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</ a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications< /h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l aunchData</a></li></ul></div></div><h3>Types (<a href="#types">↑</a>)</h3><div c lass="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a>< /li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_A nalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSe verity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">Anal ysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOptions</a></l i><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type _AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContentOverlay" >ChangeContentOverlay</a></li><li><a href="#type_CompletionId">CompletionId</a>< /li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a h ref="#type_Element">Element</a></li><li><a href="#type_ElementKind">ElementKind< /a></li><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li><a href="# type_ExecutableKind">ExecutableKind</a></li><li><a href="#type_ExecutionContextI d">ExecutionContextId</a></li><li><a href="#type_ExecutionService">ExecutionServ ice</a></li><li><a href="#type_FileKind">FileKind</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_GeneralAn alysisService">GeneralAnalysisService</a></li><li><a href="#type_HighlightRegion ">HighlightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegio nType</a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li> <a href="#type_ImplementedClass">ImplementedClass</a></li><li><a href="#type_Imp lementedMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">Li nkedEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggest ion</a></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKin d</a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_Navig ationRegion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">Navig ationTarget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a h ref="#type_Outline">Outline</a></li><li><a href="#type_Override">Override</a></l i><li><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#ty pe_Position">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><l i><a href="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Ref actoringMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_R efactoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOp tions">RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterK ind">RefactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProble m">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Ref actoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveC ontentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li> <a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_Sea rchId">SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><l i><a href="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_S erverService">ServerService</a></li><li><a href="#type_SourceChange">SourceChang e</a></li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_S ourceFileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">Type HierarchyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a> )</h3><div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METH OD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO _GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCA L_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_MET HOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INL INE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHO D</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#r efactoring_RENAME">RENAME</a></li></ul></div>
4255 4257
4256 4258
4257 </body></html> 4259 </body></html>
OLDNEW
« no previous file with comments | « no previous file | pkg/analysis_server/lib/plugin/protocol/generated_protocol.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698