Skip to content

Commit

Permalink
Nodoc consistency, update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nijikokun committed Apr 11, 2013
1 parent 4432467 commit 7d3a81c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ var oa = new OAuth({ /* … options … */ }, callback);
oa.getOAuthRequestToken({ /* … parameters … */ }, callback);
```

- parameters `{Object}` *Optional;* Additional Headers you might want to pass along.
- If omitted, you can treat parameters argument as callback and pass along a function as a single parameter.
- callback `{Function}` Anonymous Function to be invoked upon response or failure.
- `parameters` `Object` ___Optional___ *Additional Headers you might want to pass along.*
- *If omitted, you can treat parameters argument as callback and pass along a function as a single parameter.*
- `callback` `Function` *Anonymous Function to be invoked upon response or failure.*


##### Example
Expand All @@ -75,13 +75,14 @@ oa.getOAuthRequestToken(function (error, oauth_token, oauth_token_secret, result
oa.getOAuthAccessToken(options, callback);
```

- options `{Object}`
- oauth_verifier `{String}` Verification code tied to the Request Token. [Section 2.3](http://tools.ietf.org/html/rfc5849#section-2.3)
- oauth_token `{String}` Request Token
- oauth_token_secret `{String}` Request Token Secret, used to help generation of signatures.
- parameters `{Object}` *Optional;* Additional headers to be sent along with request.
- callback `{Function}` *Optional;* Method to be invoked upon result, over-ridden by argument if set.
- callback `{Function}` Method to be invoked upon result, over-rides options callback.
- `options` `Object`
- `oauth_verifier` `String` *Verification code tied to the Request Token. [Section 2.3](http://tools.ietf.org/html/rfc5849#section-2.3)
- `oauth_token` `String` *Request Token*
- `oauth_token_secret` `String` *Request Token Secret, used to help generation of signatures.*
- `parameters` `Object` ___Optional___ *Additional headers to be sent along with request.*
- `callback` `Function` ___Optional___ *Method to be invoked upon result, over-ridden by argument if set.*
- `callback` `Function` *Anonymous Function to be invoked upon response or failure, setting this overrides previously set callback inside options object.*


##### Example

Expand Down
12 changes: 6 additions & 6 deletions lib/oauth.js
Original file line number Diff line number Diff line change
Expand Up @@ -422,11 +422,11 @@ OAuth.prototype.handleRequestLong = function (url, method, token, secret, body,
// Create & handles Access Token call while extracting information from response such as Token and Secret.
//
// - `options` `Object`
// - `oauth_verifier` `String` *Verification code tied to the Request Token. [Section 2.3](http://tools.ietf.org/html/rfc5849#section-2.3)
// - `oauth_token` `String` *Request Token*
// - `oauth_token_secret` `String` *Request Token Secret, used to help generation of signatures.*
// - `parameters` `Object` ___Optional___ *Additional headers to be sent along with request.*
// - `callback` `Function` ___Optional___ *Method to be invoked upon result, over-ridden by argument if set.*
// - `oauth_verifier` `String` *Verification code tied to the Request Token. [Section 2.3](http://tools.ietf.org/html/rfc5849#section-2.3)
// - `oauth_token` `String` *Request Token*
// - `oauth_token_secret` `String` *Request Token Secret, used to help generation of signatures.*
// - `parameters` `Object` ___Optional___ *Additional headers to be sent along with request.*
// - `callback` `Function` ___Optional___ *Method to be invoked upon result, over-ridden by argument if set.*
// - `callback` `Function` *Anonymous Function to be invoked upon response or failure, setting this overrides previously set callback inside options object.*
//
// Example: (javascript)
Expand Down Expand Up @@ -457,7 +457,7 @@ OAuth.prototype.getOAuthAccessToken = function (options, callback) {
// Create & handles Request Token call while extracting information from response such as Token and Secret.
//
// - `parameters` `Object` ___Optional___ *Additional Headers you might want to pass along.*
// - *If omitted, you can treat parameters argument as callback and pass along a function as a single parameter.*
// - *If omitted, you can treat parameters argument as callback and pass along a function as a single parameter.*
// - `callback` `Function` *Anonymous Function to be invoked upon response or failure.*
//
// Example: (javascript)
Expand Down

0 comments on commit 7d3a81c

Please sign in to comment.