Commit cb17739b authored by Kenton Varda's avatar Kenton Varda

Merge pull request #256 from dwrensha/typo

Fix some documentation typos.
parents 3adcf4a1 7dd8dd17
...@@ -105,7 +105,7 @@ class Request: public Params::Builder { ...@@ -105,7 +105,7 @@ class Request: public Params::Builder {
// structure with a method send() that actually sends it. // structure with a method send() that actually sends it.
// //
// Given a Cap'n Proto method `foo(a :A, b :B): C`, the generated client interface will have // Given a Cap'n Proto method `foo(a :A, b :B): C`, the generated client interface will have
// a method `Request<FooParams, C> startFoo()` (as well as a convenience method // a method `Request<FooParams, C> fooRequest()` (as well as a convenience method
// `RemotePromise<C> foo(A::Reader a, B::Reader b)`). // `RemotePromise<C> foo(A::Reader a, B::Reader b)`).
public: public:
...@@ -298,7 +298,7 @@ public: ...@@ -298,7 +298,7 @@ public:
// //
// Keep in mind that asynchronous cancellation cannot occur while the method is synchronously // Keep in mind that asynchronous cancellation cannot occur while the method is synchronously
// executing on a local thread. The method must perform an asynchronous operation or call // executing on a local thread. The method must perform an asynchronous operation or call
// `EventLoop::current().runLater()` to yield control. // `EventLoop::current().evalLater()` to yield control.
// //
// Note: You might think that we should offer `onCancel()` and/or `isCanceled()` methods that // Note: You might think that we should offer `onCancel()` and/or `isCanceled()` methods that
// provide notification when the caller cancels the request without forcefully killing off the // provide notification when the caller cancels the request without forcefully killing off the
......
...@@ -71,7 +71,7 @@ public: ...@@ -71,7 +71,7 @@ public:
// - Throw an exception to cause the call to fail with that exception. // - Throw an exception to cause the call to fail with that exception.
// //
// `target` is the underlying capability (*inside* the membrane) for which the call is destined. // `target` is the underlying capability (*inside* the membrane) for which the call is destined.
// Generally, the only way you should use `target` is to wrap it in some capbaility which you // Generally, the only way you should use `target` is to wrap it in some capability which you
// return as a redirect. The redirect capability may modify the call in some way and send it to // return as a redirect. The redirect capability may modify the call in some way and send it to
// `target`. Be careful to use `copyIntoMembrane()` and `copyOutOfMembrane()` as appropriate when // `target`. Be careful to use `copyIntoMembrane()` and `copyOutOfMembrane()` as appropriate when
// copying parameters or results across the membrane. // copying parameters or results across the membrane.
...@@ -107,7 +107,7 @@ public: ...@@ -107,7 +107,7 @@ public:
}; };
Capability::Client membrane(Capability::Client inner, kj::Own<MembranePolicy> policy); Capability::Client membrane(Capability::Client inner, kj::Own<MembranePolicy> policy);
// Wrap `inner` in a membrane specified by `filter`. `inner` is considered "inside" the membrane, // Wrap `inner` in a membrane specified by `policy`. `inner` is considered "inside" the membrane,
// while the returned capability should only be called from outside the membrane. // while the returned capability should only be called from outside the membrane.
Capability::Client reverseMembrane(Capability::Client outer, kj::Own<MembranePolicy> policy); Capability::Client reverseMembrane(Capability::Client outer, kj::Own<MembranePolicy> policy);
......
...@@ -146,8 +146,8 @@ class UnixEventPort::FdObserver { ...@@ -146,8 +146,8 @@ class UnixEventPort::FdObserver {
// else, it means that read() (or recv()) will return data. // else, it means that read() (or recv()) will return data.
// //
// The presence of out-of-band data should NOT fire this event. However, the event may // The presence of out-of-band data should NOT fire this event. However, the event may
// occasionally fire spurriously (when there is actually no data to read), and one thing that can // occasionally fire spuriously (when there is actually no data to read), and one thing that can
// cause such spurrious events is the arrival of OOB data on certain platforms whose event // cause such spurious events is the arrival of OOB data on certain platforms whose event
// interfaces fail to distinguish between regular and OOB data (e.g. Mac OSX). // interfaces fail to distinguish between regular and OOB data (e.g. Mac OSX).
// //
// WARNING: The exact behavior of this class differs across systems, since event interfaces // WARNING: The exact behavior of this class differs across systems, since event interfaces
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment