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

Unified Diff: sdk/lib/developer/service.dart

Issue 2499763002: Fix some comments. (Closed)
Patch Set: Address self review comments. Created 4 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « sdk/lib/developer/extension.dart ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sdk/lib/developer/service.dart
diff --git a/sdk/lib/developer/service.dart b/sdk/lib/developer/service.dart
index 2934afe41f09ee5c592eafbc60cee3e87181e8eb..9ccf0dccc268ca48fda44572f341057987be6ff3 100644
--- a/sdk/lib/developer/service.dart
+++ b/sdk/lib/developer/service.dart
@@ -4,7 +4,10 @@
part of dart.developer;
-/// Information about the service protocol.
+/// Service protocol is the protocol that a client like the observatory
+/// could use to access the services provided by the Dart VM for
+/// debugging and inspecting Dart programs. This class encapsulates the
+/// version number and Uri for accessing this service.
class ServiceProtocolInfo {
/// The major version of the protocol. If the running Dart environment does
/// not support the service protocol, this is 0.
@@ -28,9 +31,12 @@ class ServiceProtocolInfo {
}
}
-/// Access information about the service protocol and control the web server.
+/// Access information about the service protocol and control the web server
+/// that provides access to the services provided by the Dart VM for
+/// debugging and inspecting Dart programs.
class Service {
- /// Get information about the service protocol.
+ /// Get information about the service protocol (version number and
+ /// Uri to access the service).
static Future<ServiceProtocolInfo> getInfo() async {
// Port to receive response from service isolate.
final RawReceivePort receivePort = new RawReceivePort();
@@ -46,6 +52,8 @@ class Service {
}
/// Control the web server that the service protocol is accessed through.
+ /// The [enable] argument must be a boolean and is used as a toggle to
+ /// enable(true) or disable(false) the web server servicing requests.
static Future<ServiceProtocolInfo> controlWebServer(
{bool enable: false}) async {
if (enable is! bool) {
« no previous file with comments | « sdk/lib/developer/extension.dart ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698