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

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

Issue 2382053002: Remove unused option in server API (Closed)
Patch Set: Created 4 years, 2 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 | « 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 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Co de+Pro|Roboto:500,400italic,300,400" type="text/css"><style>body { 4 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Co de+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 796 matching lines...) Expand 10 before | Expand all | Expand 10 after
807 analyzed. 807 analyzed.
808 </p> 808 </p>
809 </dd><dt class="field"><b>excluded (List&lt;<a href="#type_FilePath">F ilePath</a>&gt;)</b></dt><dd> 809 </dd><dt class="field"><b>excluded (List&lt;<a href="#type_FilePath">F ilePath</a>&gt;)</b></dt><dd>
810 810
811 <p> 811 <p>
812 A list of the files and directories within the 812 A list of the files and directories within the
813 included directories that should not be analyzed. 813 included directories that should not be analyzed.
814 </p> 814 </p>
815 </dd><dt class="field"><b>packageRoots (<span style="color:#999999">op tional</span> Map&lt;<a href="#type_FilePath">FilePath</a>, <a href="#type_FileP ath">FilePath</a>&gt;)</b></dt><dd> 815 </dd><dt class="field"><b>packageRoots (<span style="color:#999999">op tional</span> Map&lt;<a href="#type_FilePath">FilePath</a>, <a href="#type_FileP ath">FilePath</a>&gt;)</b></dt><dd>
816 816
817 <p><b><i>Deprecated</i></b>: This field is now ignored by server.</p >
817 <p> 818 <p>
818 A mapping from source directories to package roots 819 A mapping from source directories to package roots
819 that should override the normal package: URI resolution 820 that should override the normal package: URI resolution
820 mechanism. 821 mechanism.
821 </p> 822 </p>
822 <p> 823 <p>
823 If a package root is a directory, then 824 If a package root is a directory, then
824 the analyzer will behave as though the associated 825 the analyzer will behave as though the associated
825 source directory in the map contains a special 826 source directory in the map contains a special
826 pubspec.yaml file which resolves any package: URI to the 827 pubspec.yaml file which resolves any package: URI to the
(...skipping 3647 matching lines...) Expand 10 before | Expand all | Expand 10 after
4474 produced by the server and the data that is returned with each. 4475 produced by the server and the data that is returned with each.
4475 </p> 4476 </p>
4476 <p> 4477 <p>
4477 TODO: TBD 4478 TODO: TBD
4478 </p> 4479 </p>
4479 <h2 class="domain"><a name="index">Index</a></h2> 4480 <h2 class="domain"><a name="index">Index</a></h2>
4480 <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.getReachable Sources">getReachableSources</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><h4>diagnostic (<a href="#domain_diagnostic"> ↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diag nostic.getDiagnostics">getDiagnostics</a></li></ul></div><h3>Types (<a href="#ty pes">↑</a>)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay"> AddContentOverlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></l i><li><a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href= "#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_A nalysisErrorType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions"> AnalysisOptions</a></li><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_Completio nId">CompletionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSug gestion</a></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestio nKind</a></li><li><a href="#type_ContextData">ContextData</a></li><li><a href="# type_Element">Element</a></li><li><a href="#type_ElementKind">ElementKind</a></l i><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_E xecutableKind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">Exe cutionContextId</a></li><li><a href="#type_ExecutionService">ExecutionService</a ></li><li><a href="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath" >FilePath</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a hre f="#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysis Service">GeneralAnalysisService</a></li><li><a href="#type_HighlightRegion">High lightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType< /a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li><a hre f="#type_ImplementedClass">ImplementedClass</a></li><li><a href="#type_Implement edMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEd itGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a ></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a>< /li><li><a href="#type_Location">Location</a></li><li><a href="#type_NavigationR egion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">NavigationT arget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a href="# type_Outline">Outline</a></li><li><a href="#type_Override">Override</a></li><li> <a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Pos ition">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a h ref="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_Refacto ringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions" >RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">R efactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProblem">Ref actoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Refactori ngProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContent Overlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li><a hre f="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId" >SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a h ref="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerS ervice">ServerService</a></li><li><a href="#type_SourceChange">SourceChange</a>< /li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceF ileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierar chyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3> <div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CO NVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTE R">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARI ABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">E XTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LO CAL_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="#refacto ring_RENAME">RENAME</a></li></ul></div> 4481 <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.getReachable Sources">getReachableSources</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><h4>diagnostic (<a href="#domain_diagnostic"> ↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_diag nostic.getDiagnostics">getDiagnostics</a></li></ul></div><h3>Types (<a href="#ty pes">↑</a>)</h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay"> AddContentOverlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></l i><li><a href="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href= "#type_AnalysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_A nalysisErrorType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions"> AnalysisOptions</a></li><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_Completio nId">CompletionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSug gestion</a></li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestio nKind</a></li><li><a href="#type_ContextData">ContextData</a></li><li><a href="# type_Element">Element</a></li><li><a href="#type_ElementKind">ElementKind</a></l i><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#type_E xecutableKind">ExecutableKind</a></li><li><a href="#type_ExecutionContextId">Exe cutionContextId</a></li><li><a href="#type_ExecutionService">ExecutionService</a ></li><li><a href="#type_FileKind">FileKind</a></li><li><a href="#type_FilePath" >FilePath</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li><a hre f="#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAnalysis Service">GeneralAnalysisService</a></li><li><a href="#type_HighlightRegion">High lightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegionType< /a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li><a hre f="#type_ImplementedClass">ImplementedClass</a></li><li><a href="#type_Implement edMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">LinkedEd itGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a ></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind</a>< /li><li><a href="#type_Location">Location</a></li><li><a href="#type_NavigationR egion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">NavigationT arget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a href="# type_Outline">Outline</a></li><li><a href="#type_Override">Override</a></li><li> <a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#type_Pos ition">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li><a h ref="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Refactori ngMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_Refacto ringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOptions" >RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterKind">R efactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProblem">Ref actoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Refactori ngProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveContent Overlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li><a hre f="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_SearchId" >SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><li><a h ref="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_ServerS ervice">ServerService</a></li><li><a href="#type_SourceChange">SourceChange</a>< /li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_SourceF ileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeHierar chyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>)</h3> <div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHOD">CO NVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO_GETTE R">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCAL_VARI ABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METHOD">E XTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLINE_LO CAL_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="#refacto ring_RENAME">RENAME</a></li></ul></div>
4481 4482
4482 4483
4483 </body></html> 4484 </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