pkg/analysis_server/tool/spec/spec_input.html - Issue 1375163003: Specification change for the 'libraryName' and 'partOfLibraryName' fields in Outline.

Side by Side Diff: pkg/analysis_server/tool/spec/spec_input.html

Issue 1375163003: Specification change for the 'libraryName' and 'partOfLibraryName' fields in Outline. (Closed) Base URL: git@github.com:dart-lang/sdk.git@master

Patch Set: Created 5 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

OLD	NEW
1 <!doctype html>	1 <!doctype html>

2 <html>	2 <html>

3 <head>	3 <head>

4 <meta charset="UTF-8"/>	4 <meta charset="UTF-8"/>

5 <title>Analysis Server API Specification</title>	5 <title>Analysis Server API Specification</title>

6 </head>	6 </head>

7 <body>	7 <body>

8 <h1>Analysis Server API Specification</h1>	8 <h1>Analysis Server API Specification</h1>

9 <h1 style="color:#999999">Version <version>1.9.0</version></h1>	9 <h1 style="color:#999999">Version <version>1.9.0</version></h1>
	Paul Berry 2015/10/01 16:00:44 Since this is a backward-compatible change to the Since this is a backward-compatible change to the API, we should rev the version to 1.10.0. Don't forget to also change the VERSION constant in pkg/analysis_server/lib/src/analysis_server.dart.
10 <p>	10 <p>

11 This document contains a specification of the API provided by the	11 This document contains a specification of the API provided by the

12 analysis server. The API in this document is currently under	12 analysis server. The API in this document is currently under

13 development. Changes to the API will be accompanied by an update to the	13 development. Changes to the API will be accompanied by an update to the

14 protocol version number according to the principles of semantic	14 protocol version number according to the principles of semantic

15 versioning <a href="http://semver.org/">http://semver.org/</a>.	15 versioning <a href="http://semver.org/">http://semver.org/</a>.

16 </p>	16 </p>

17 <h2>Overview</h2>	17 <h2>Overview</h2>

18 <p>	18 <p>

19 The analysis server API is a bi-directional client-server	19 The analysis server API is a bi-directional client-server

(...skipping 1017 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1037 the list of services passed in an analysis.setSubscriptions	1037 the list of services passed in an analysis.setSubscriptions

1038 request.	1038 request.

1039 </p>	1039 </p>

1040 <params>	1040 <params>

1041 <field name="file">	1041 <field name="file">

1042 <ref>FilePath</ref>	1042 <ref>FilePath</ref>

1043 <p>	1043 <p>

1044 The file with which the outline is associated.	1044 The file with which the outline is associated.

1045 </p>	1045 </p>

1046 </field>	1046 </field>

	1047 <field name="libraryName">

	1048 <ref>String</ref>

	1049 <p>

	1050 The name of the library defined by the file.
	Paul Berry 2015/10/01 16:00:44 We should clarify what happens if the file is the We should clarify what happens if the file is the defining compilation unit of a library, but the library is unnamed (i.e. there is neither a "library" declaration nor a "part of" declaration). Suggestion: in this case, libraryName should be the empty string. We should also clarify what happens if the file is a "part" file (i.e. it contains a "part of" declaration). Suggestion: in this case, libraryName should be absent. (And libraryName should be optional).
	1051 </p>

	1052 </field>

1047 <field name="outline">	1053 <field name="outline">

1048 <ref>Outline</ref>	1054 <ref>Outline</ref>

1049 <p>	1055 <p>

1050 The outline associated with the file.	1056 The outline associated with the file.

1051 </p>	1057 </p>

1052 </field>	1058 </field>

	1059 <field name="partOfLibraryName">
	Brian Wilkerson 2015/10/01 16:13:00 Do we need to differentiate between a library and Do we need to differentiate between a library and a part? I agree with Paul that both "libraryName" and "partOfLibraryName" should be optional because there will either be one or the other but never both. But I have to ask: would it work to have one optional field whose value is the name in the library directive if one exists, the name in the part-of directive if one exists, and otherwise it is omitted? Doing so wouldn't allow a client to know whether they're looking at a library or a part, but I don't know whether that's useful. If it is, it might be less confusing to add a "kind" field.
	1060 <ref>String</ref>

	1061 <p>

	1062 The name of the library the file in a part of.
	Paul Berry 2015/10/01 16:00:44 We should clarify what happens if the file is not We should clarify what happens if the file is not a "part" file (i.e. it lacks a "part of" declaration). Suggestion: in this case, partOfLibraryName should be absent. (And partOfLibraryName should be optional). We should also clarify what happens if another file references this file as a part, but this file lacks a "part of" declaration. (This is an error condition but it could arise during editing). Suggestion: in this case, partOfLibraryName should be absent.
	1063 </p>

	1064 </field>

1053 </params>	1065 </params>

1054 </notification>	1066 </notification>

1055 <notification event="overrides">	1067 <notification event="overrides">

1056 <p>	1068 <p>

1057 Reports the overridding members in a file.	1069 Reports the overridding members in a file.

1058 </p>	1070 </p>

1059 <p>	1071 <p>

1060 This notification is not subscribed to by default. Clients	1072 This notification is not subscribed to by default. Clients

1061 can subscribe by including the value <tt>"OVERRIDES"</tt> in	1073 can subscribe by including the value <tt>"OVERRIDES"</tt> in

1062 the list of services passed in an analysis.setSubscriptions	1074 the list of services passed in an analysis.setSubscriptions

(...skipping 3249 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
4312 This section contains a list of all of the errors that are	4324 This section contains a list of all of the errors that are

4313 produced by the server and the data that is returned with each.	4325 produced by the server and the data that is returned with each.

4314 </p>	4326 </p>

4315 <p>	4327 <p>

4316 TBD	4328 TBD

4317 </p>	4329 </p>

4318 <h2 class="domain"><a name="index">Index</a></h2>	4330 <h2 class="domain"><a name="index">Index</a></h2>

4319 <index></index>	4331 <index></index>

4320 </body>	4332 </body>

4321 </html>	4333 </html>

OLD	NEW

« no previous file with comments | « pkg/analysis_server/test/integration/protocol_matchers.dart ('k') | no next file » | no next file with comments »