Add quick reference for bind/callback usage.

Add quick reference for bind/callback usage.

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=146425

[brettw, 2012-07-10 23:51:38]

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h
File base/callback.h (right):

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h#newcode74
base/callback.h:74: // RUNNING A CALLBACK
This section is new since I deleted your old examples showing how to run them.

[awong, 2012-07-11 00:04:17]

couple of small nits.

https://chromiumcodereview.appspot.com/10692147/diff/1/base/bind.h
File base/bind.h (right):

https://chromiumcodereview.appspot.com/10692147/diff/1/base/bind.h#newcode18
base/bind.h:18: // User documentation
What about "Usage documentation" instead of "User documentation"?

I think Usage sounds more clear, but am fine with either.

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h
File base/callback.h (right):

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h#newcod...
base/callback.h:169: //   base::Callback cb =
base::Bind(base::IgnoreResult(&DoSomething));
base::Closure

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h#newcod...
base/callback.h:178: // closure (base::Callback<void(void)> and base::Closure
are the same thing).
s/closure/Closure/

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h#newcod...
base/callback.h:193: //   // f becomes null during this call.
during this -> during the following

It it work noting that you can't make a call like the following:

void Foo(Foo*, const Closure& c);
Foo(f.get(), base::Bind(&TaskesOwnership, base::Passed(&f));

because f.get()'s result is undefined?  Or does this fall in the realm of
programmers should know better if they're using C++?

[brettw, 2012-07-11 17:23:24]

new snap up.

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h
File base/callback.h (right):

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h#newcod...
base/callback.h:169: //   base::Callback cb =
base::Bind(base::IgnoreResult(&DoSomething));
I changed this to Callback<void(int)> which I think is correct.

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h#newcod...
base/callback.h:193: //   // f becomes null during this call.
I think your suggestion doesn't really feel like it fits in the quick reference
to me, and if you understand Passed it should be clear. Plus it will probably
crash when you run it and then you'll fix your code :)

[awong, 2012-07-11 18:07:43]

LGTM

Serious thanks for doing this!  I know lots of people have wanted better docs
for a while.

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h
File base/callback.h (right):

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h#newcod...
base/callback.h:169: //   base::Callback cb =
base::Bind(base::IgnoreResult(&DoSomething));
On 2012/07/11 17:23:24, brettw wrote:
> I changed this to Callback<void(int)> which I think is correct.

Ah yes...that is the correct one.

https://chromiumcodereview.appspot.com/10692147/diff/1/base/callback.h#newcod...
base/callback.h:193: //   // f becomes null during this call.
On 2012/07/11 17:23:24, brettw wrote:
> I think your suggestion doesn't really feel like it fits in the quick
reference
> to me, and if you understand Passed it should be clear. Plus it will probably
> crash when you run it and then you'll fix your code :)

SGTM