Skip to content

Commit

Permalink
Fixed IsolateNameServer documentation (flutter#6344)
Browse files Browse the repository at this point in the history
We were using `//` instead of `///` so docs were not being generated.
  • Loading branch information
bkonyi authored Sep 26, 2018
1 parent 0c854ac commit d6bb599
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions lib/ui/isolate_name_server.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,31 @@

part of dart.ui;

/// Contains methods to allow for simple sharing of SendPorts across isolates.
abstract class IsolateNameServer {
// Looks up the [SendPort] associated with a given name. Returns null
// if the name does not exist.
//
// `name` must not be null.
/// Looks up the [SendPort] associated with a given name. Returns null
/// if the name does not exist.
///
/// `name` must not be null.
static SendPort lookupPortByName(String name) {
assert(name != null, "'name' cannot be null.");
return _lookupPortByName(name);
}

// Registers a SendPort with a given name. Returns true if registration is
// successful, false if the name entry already exists.
//
// `port` and `name` must not be null.
/// Registers a SendPort with a given name. Returns true if registration is
/// successful, false if the name entry already exists.
///
/// `port` and `name` must not be null.
static bool registerPortWithName(SendPort port, String name) {
assert(port != null, "'port' cannot be null.");
assert(name != null, "'name' cannot be null.");
return _registerPortWithName(port, name);
}

// Removes a name to SendPort mapping given a name. Returns true if the
// mapping was successfully removed, false if the mapping does not exist.
//
// `name` must not be null.
/// Removes a name to SendPort mapping given a name. Returns true if the
/// mapping was successfully removed, false if the mapping does not exist.
///
/// `name` must not be null.
static bool removePortNameMapping(String name) {
assert(name != null, "'name' cannot be null.");
return _removePortNameMapping(name);
Expand Down

0 comments on commit d6bb599

Please sign in to comment.