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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 1328273002: Explicitly document that NavigationRegion.targets cannot be empty. (Closed) Base URL: git@github.com:dart-lang/sdk.git@master
Patch Set: Created 5 years, 3 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/src/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 <html><head> 1 <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 3124 matching lines...) Expand 10 before | Expand all | Expand 10 after
3135 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> 3135 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>
3136 3136
3137 <p> 3137 <p>
3138 The length of the region from which the user can navigate. 3138 The length of the region from which the user can navigate.
3139 </p> 3139 </p>
3140 </dd><dt class="field"><b><i>targets ( List&lt;int&gt; )</i></b></dt>< dd> 3140 </dd><dt class="field"><b><i>targets ( List&lt;int&gt; )</i></b></dt>< dd>
3141 3141
3142 <p> 3142 <p>
3143 The indexes of the targets (in the enclosing navigation response) 3143 The indexes of the targets (in the enclosing navigation response)
3144 to which the given region is bound. By opening the target, clients 3144 to which the given region is bound. By opening the target, clients
3145 can implement one form of navigation. 3145 can implement one form of navigation. This list cannot be empty.
3146 </p> 3146 </p>
3147 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarg et">NavigationTarget: object</a></dt><dd> 3147 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarg et">NavigationTarget: object</a></dt><dd>
3148 <p> 3148 <p>
3149 A description of a target to which the user can navigate. 3149 A description of a target to which the user can navigate.
3150 </p> 3150 </p>
3151 3151
3152 <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind </a> )</i></b></dt><dd> 3152 <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind </a> )</i></b></dt><dd>
3153 3153
3154 <p> 3154 <p>
3155 The kind of the element. 3155 The kind of the element.
(...skipping 973 matching lines...) Expand 10 before | Expand all | Expand 10 after
4129 <h2>Errors</h2> 4129 <h2>Errors</h2>
4130 <p> 4130 <p>
4131 This section contains a list of all of the errors that are 4131 This section contains a list of all of the errors that are
4132 produced by the server and the data that is returned with each. 4132 produced by the server and the data that is returned with each.
4133 </p> 4133 </p>
4134 <p> 4134 <p>
4135 TBD 4135 TBD
4136 </p> 4136 </p>
4137 <h2 class="domain"><a name="index">Index</a></h2> 4137 <h2 class="domain"><a name="index">Index</a></h2>
4138 <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.inv alidate">invalidate</a></li><li><a href="#notification_analysis.navigation">navi gation</a></li><li><a href="#notification_analysis.occurrences">occurrences</a>< /li><li><a href="#notification_analysis.outline">outline</a></li><li><a href="#n otification_analysis.overrides">overrides</a></li></ul></div></div><h4>completio n (<a href="#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h 5><ul><li><a href="#request_completion.getSuggestions">getSuggestions</a></li></ ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_co mpletion.results">results</a></li></ul></div></div><h4>search (<a href="#domain_ search">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#requ est_search.findElementReferences">findElementReferences</a></li><li><a href="#re quest_search.findMemberDeclarations">findMemberDeclarations</a></li><li><a href= "#request_search.findMemberReferences">findMemberReferences</a></li><li><a href= "#request_search.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li> <a href="#request_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Not ifications</h5><div class="subindex"><ul><li><a href="#notification_search.resul ts">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">f ormat</a></li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a h ref="#request_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><l i><a href="#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.g etRefactoring">getRefactoring</a></li><li><a href="#request_edit.sortMembers">so rtMembers</a></li><li><a href="#request_edit.organizeDirectives">organizeDirecti ves</a></li></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><di v class="subindex"><h5>Requests</h5><ul><li><a href="#request_execution.createCo ntext">createContext</a></li><li><a href="#request_execution.deleteContext">dele teContext</a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#request_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Not ifications</h5><div class="subindex"><ul><li><a href="#notification_execution.la unchData">launchData</a></li></ul></div></div><h3>Types (<a href="#types">↑</a>) </h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentO verlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a hr ef="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Anal ysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErro rType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOpt ions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeCont entOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Comple tionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a> </li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></ li><li><a href="#type_Element">Element</a></li><li><a href="#type_ElementKind">E lementKind</a></li><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li ><a href="#type_ExecutableKind">ExecutableKind</a></li><li><a href="#type_Execut ionContextId">ExecutionContextId</a></li><li><a href="#type_ExecutionService">Ex ecutionService</a></li><li><a href="#type_FilePath">FilePath</a></li><li><a href ="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_FoldingRegion">Foldi ngRegion</a></li><li><a href="#type_GeneralAnalysisService">GeneralAnalysisServi ce</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a></li><li><a hr ef="#type_HighlightRegionType">HighlightRegionType</a></li><li><a href="#type_Ho verInformation">HoverInformation</a></li><li><a href="#type_LinkedEditGroup">Lin kedEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggesti on</a></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind </a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_Naviga tionRegion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">Naviga tionTarget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a hr ef="#type_Outline">Outline</a></li><li><a href="#type_Override">Override</a></li ><li><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#typ e_Position">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li ><a href="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Refa ctoringMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_Re factoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOpt ions">RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterKi nd">RefactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProblem ">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Refa ctoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveCo ntentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li>< a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_Sear chId">SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><li ><a href="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_Se rverService">ServerService</a></li><li><a href="#type_SourceChange">SourceChange </a></li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_So urceFileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeH ierarchyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>) </h3><div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHO D">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_LOCAL _VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METH OD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLI NE_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="#re factoring_RENAME">RENAME</a></li></ul></div></body></html> 4138 <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.inv alidate">invalidate</a></li><li><a href="#notification_analysis.navigation">navi gation</a></li><li><a href="#notification_analysis.occurrences">occurrences</a>< /li><li><a href="#notification_analysis.outline">outline</a></li><li><a href="#n otification_analysis.overrides">overrides</a></li></ul></div></div><h4>completio n (<a href="#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h 5><ul><li><a href="#request_completion.getSuggestions">getSuggestions</a></li></ ul><h5>Notifications</h5><div class="subindex"><ul><li><a href="#notification_co mpletion.results">results</a></li></ul></div></div><h4>search (<a href="#domain_ search">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#requ est_search.findElementReferences">findElementReferences</a></li><li><a href="#re quest_search.findMemberDeclarations">findMemberDeclarations</a></li><li><a href= "#request_search.findMemberReferences">findMemberReferences</a></li><li><a href= "#request_search.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li> <a href="#request_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Not ifications</h5><div class="subindex"><ul><li><a href="#notification_search.resul ts">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">f ormat</a></li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a h ref="#request_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><l i><a href="#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.g etRefactoring">getRefactoring</a></li><li><a href="#request_edit.sortMembers">so rtMembers</a></li><li><a href="#request_edit.organizeDirectives">organizeDirecti ves</a></li></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><di v class="subindex"><h5>Requests</h5><ul><li><a href="#request_execution.createCo ntext">createContext</a></li><li><a href="#request_execution.deleteContext">dele teContext</a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#request_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Not ifications</h5><div class="subindex"><ul><li><a href="#notification_execution.la unchData">launchData</a></li></ul></div></div><h3>Types (<a href="#types">↑</a>) </h3><div class="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentO verlay</a></li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a hr ef="#type_AnalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_Anal ysisErrorSeverity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErro rType">AnalysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOpt ions</a></li><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeCont entOverlay">ChangeContentOverlay</a></li><li><a href="#type_CompletionId">Comple tionId</a></li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a> </li><li><a href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></ li><li><a href="#type_Element">Element</a></li><li><a href="#type_ElementKind">E lementKind</a></li><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li ><a href="#type_ExecutableKind">ExecutableKind</a></li><li><a href="#type_Execut ionContextId">ExecutionContextId</a></li><li><a href="#type_ExecutionService">Ex ecutionService</a></li><li><a href="#type_FilePath">FilePath</a></li><li><a href ="#type_FoldingKind">FoldingKind</a></li><li><a href="#type_FoldingRegion">Foldi ngRegion</a></li><li><a href="#type_GeneralAnalysisService">GeneralAnalysisServi ce</a></li><li><a href="#type_HighlightRegion">HighlightRegion</a></li><li><a hr ef="#type_HighlightRegionType">HighlightRegionType</a></li><li><a href="#type_Ho verInformation">HoverInformation</a></li><li><a href="#type_LinkedEditGroup">Lin kedEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggesti on</a></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKind </a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_Naviga tionRegion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">Naviga tionTarget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a hr ef="#type_Outline">Outline</a></li><li><a href="#type_Override">Override</a></li ><li><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#typ e_Position">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><li ><a href="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Refa ctoringMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_Re factoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOpt ions">RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterKi nd">RefactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProblem ">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Refa ctoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveCo ntentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li>< a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_Sear chId">SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><li ><a href="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_Se rverService">ServerService</a></li><li><a href="#type_SourceChange">SourceChange </a></li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_So urceFileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">TypeH ierarchyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>) </h3><div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METHO D">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_LOCAL _VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_METH OD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INLI NE_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="#re factoring_RENAME">RENAME</a></li></ul></div></body></html>
OLDNEW
« no previous file with comments | « no previous file | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698