From b576a66c4b8559bb2b1818d80761ab7ed7bf519f Mon Sep 17 00:00:00 2001 From: Guenter Obiltschnig Date: Tue, 11 Nov 2014 17:10:37 +0100 Subject: [PATCH] documentation update --- Net/include/Poco/Net/OAuth20Credentials.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/Net/include/Poco/Net/OAuth20Credentials.h b/Net/include/Poco/Net/OAuth20Credentials.h index 6a641d216..e622cca1e 100644 --- a/Net/include/Poco/Net/OAuth20Credentials.h +++ b/Net/include/Poco/Net/OAuth20Credentials.h @@ -34,6 +34,19 @@ class Net_API OAuth20Credentials /// This class implements OAuth 2.0 authentication for HTTP requests, /// via Bearer tokens in the Authorization header, /// according to RFC 6749 and RFC 6750. + /// + /// To add an Authorization header containing a bearer token + /// to a HTTPRequest object, create an OAuth20Credentials object + /// with the bearer token and call authenticate(). + /// + /// The bearer token can also be extracted from a HTTPRequest + /// by creating the OAuth20Credentials object with a HTTPRequest + /// object containing a "Bearer" Authorization header and + /// calling getBearerToken(). + /// + /// The authorization header scheme can be changed from + /// "Bearer" to a custom value. For example, GitHub uses + /// the "token" scheme. { public: OAuth20Credentials();