summaryrefslogtreecommitdiffstats
path: root/chrome/browser/cancelable_request.h
diff options
context:
space:
mode:
authorjoth@chromium.org <joth@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2010-02-17 16:16:56 +0000
committerjoth@chromium.org <joth@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2010-02-17 16:16:56 +0000
commitc01b9b5ba4bb2d97518399fa74c2c384384f052f (patch)
tree65a3e606e0804636fe5d169929a981ddb5c0ec06 /chrome/browser/cancelable_request.h
parenta120891ec61a84cbcde5489ce26f92583689ff4e (diff)
downloadchromium_src-c01b9b5ba4bb2d97518399fa74c2c384384f052f.zip
chromium_src-c01b9b5ba4bb2d97518399fa74c2c384384f052f.tar.gz
chromium_src-c01b9b5ba4bb2d97518399fa74c2c384384f052f.tar.bz2
Misc. tidy up of various comments found whilst learning the codebase.
Fix a lint warning in render_messages.h (supersedes http://codereview.chromium.org/464072/show) Also implement a couple comments in geolocaiton/ in follow up to http://codereview.chromium.org/604019 BUG=none TEST=none Review URL: http://codereview.chromium.org/600128 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@39222 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/browser/cancelable_request.h')
-rw-r--r--chrome/browser/cancelable_request.h10
1 files changed, 7 insertions, 3 deletions
diff --git a/chrome/browser/cancelable_request.h b/chrome/browser/cancelable_request.h
index f771d02..514a0d7 100644
--- a/chrome/browser/cancelable_request.h
+++ b/chrome/browser/cancelable_request.h
@@ -18,8 +18,11 @@
//
// class MyClass {
// void MakeRequest() {
-// frontend_service->StartRequest(some_input1, some_input2, this,
+// frontend_service->StartRequest(some_input1, some_input2,
+// &callback_consumer_,
// NewCallback(this, &MyClass:RequestComplete));
+// // StartRequest() returns a Handle which may be retained for use with
+// // CancelRequest() if required, e.g. in MyClass's destructor.
// }
//
// void RequestComplete(int status) {
@@ -27,7 +30,7 @@
// }
//
// private:
-// CallbackConsumer callback_consumer_;
+// CancelableRequestConsumer callback_consumer_;
// };
//
//
@@ -38,7 +41,7 @@
// typedef Callback1<int>::Type RequestCallbackType;
//
// Handle StartRequest(int some_input1, int some_input2,
-// CallbackConsumer* consumer,
+// CancelableRequestConsumer* consumer,
// RequestCallbackType* callback) {
// scoped_refptr<CancelableRequest<RequestCallbackType> > request(
// new CancelableRequest<RequestCallbackType>(callback));
@@ -117,6 +120,7 @@ class CancelableRequestProvider {
// Called by the enduser of the request to cancel it. This MUST be called on
// the same thread that originally issued the request (which is also the same
// thread that would have received the callback if it was not canceled).
+ // handle must be for a valid pending (not yet complete or cancelled) request.
void CancelRequest(Handle handle);
protected: