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

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

Issue 456613004: Integration test search.getTypeHierarchy and make some minor fixes. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 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 | Annotate | Revision Log
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>h1 { 4 <style>h1 {
5 text-align: center; 5 text-align: center;
6 } 6 }
7 pre { 7 pre {
8 margin: 0px; 8 margin: 0px;
9 } 9 }
10 div.box { 10 div.box {
(...skipping 1119 matching lines...) Expand 10 before | Expand all | Expand 10 after
1130 "id": String 1130 "id": String
1131 "method": "search.getTypeHierarchy" 1131 "method": "search.getTypeHierarchy"
1132 "params": { 1132 "params": {
1133 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 1133 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
1134 "<b>offset</b>": int 1134 "<b>offset</b>": int
1135 } 1135 }
1136 }</pre><br><pre>response: { 1136 }</pre><br><pre>response: {
1137 "id": String 1137 "id": String
1138 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 1138 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a>
1139 "result": { 1139 "result": {
1140 "<b>hierarchyItems</b>": List&lt;<a href="#type_TypeHierarchyItem">TypeHiera rchyItem</a>&gt; 1140 "<b>hierarchyItems</b>": <span style="color:#999999">optional</span> List&lt ;<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>&gt;
1141 } 1141 }
1142 }</pre></div> 1142 }</pre></div>
1143 <p> 1143 <p>
1144 Return the type hierarchy of the class declared or 1144 Return the type hierarchy of the class declared or
1145 referenced at the given location. 1145 referenced at the given location.
1146 </p> 1146 </p>
1147 1147
1148 1148
1149 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd> 1149 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
1150 1150
1151 <p> 1151 <p>
1152 The file containing the declaration or reference to the 1152 The file containing the declaration or reference to the
1153 type for which a hierarchy is being requested. 1153 type for which a hierarchy is being requested.
1154 </p> 1154 </p>
1155 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> 1155 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
1156 1156
1157 <p> 1157 <p>
1158 The offset of the name of the type within the file. 1158 The offset of the name of the type within the file.
1159 </p> 1159 </p>
1160 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hierarchyItems ( List&lt;<a href="#type_TypeHierarchyItem">TypeHierarchyItem</a>&gt; )</i></b></ dt><dd> 1160 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hierarchyItems ( <span style="color:#999999">optional</span> List&lt;<a href="#type_TypeHierarch yItem">TypeHierarchyItem</a>&gt; )</i></b></dt><dd>
1161 1161
1162 <p> 1162 <p>
1163 A list of the types in the requested hierarchy. The 1163 A list of the types in the requested hierarchy. The
1164 first element of the list is the item representing the 1164 first element of the list is the item representing the
1165 type for which the hierarchy was requested. The index of 1165 type for which the hierarchy was requested. The index of
1166 other elements of the list is unspecified, but 1166 other elements of the list is unspecified, but
1167 correspond to the integers used to reference supertype 1167 correspond to the integers used to reference supertype
1168 and subtype items within the items. 1168 and subtype items within the items.
1169 </p> 1169 </p>
1170 <p>
1171 This field will be absent if the code at the given file
1172 and offset does not represent a type, or if the file has
1173 not been sufficiently analyzed to allow a type hierarchy
1174 to be produced.
1175 </p>
1170 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >search.results</dt><dd><div class="box"><pre>notification: { 1176 </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification" >search.results</dt><dd><div class="box"><pre>notification: {
1171 "event": "search.results" 1177 "event": "search.results"
1172 "params": { 1178 "params": {
1173 "<b>id</b>": <a href="#type_SearchId">SearchId</a> 1179 "<b>id</b>": <a href="#type_SearchId">SearchId</a>
1174 "<b>results</b>": List&lt;<a href="#type_SearchResult">SearchResult</a>&gt; 1180 "<b>results</b>": List&lt;<a href="#type_SearchResult">SearchResult</a>&gt;
1175 "<b>last</b>": bool 1181 "<b>last</b>": bool
1176 } 1182 }
1177 }</pre></div> 1183 }</pre></div>
1178 <p> 1184 <p>
1179 Reports some or all of the results of performing a requested 1185 Reports some or all of the results of performing a requested
(...skipping 1782 matching lines...) Expand 10 before | Expand all | Expand 10 after
2962 <p> 2968 <p>
2963 This section contains a list of all of the errors that are 2969 This section contains a list of all of the errors that are
2964 produced by the server and the data that is returned with each. 2970 produced by the server and the data that is returned with each.
2965 </p> 2971 </p>
2966 <p> 2972 <p>
2967 TBD 2973 TBD
2968 </p> 2974 </p>
2969 2975
2970 2976
2971 </body></html> 2977 </body></html>
OLDNEW
« no previous file with comments | « no previous file | pkg/analysis_server/lib/src/protocol.dart » ('j') | pkg/analysis_server/lib/src/search/search_domain.dart » ('J')

Powered by Google App Engine
This is Rietveld 408576698