Sorin Marian Nasoi has proposed merging lp:~zorba-coders/zorba/fix_xqdoc_oauth_module into lp:zorba/oauth-module.
Requested reviews: Zorba Coders (zorba-coders) For more details, see: https://code.launchpad.net/~zorba-coders/zorba/fix_xqdoc_oauth_module/+merge/103377 - added XQDoc comments for some parameters in client.xq - removed unused function in error.xq and corrected some typo's -- https://code.launchpad.net/~zorba-coders/zorba/fix_xqdoc_oauth_module/+merge/103377 Your team Zorba Coders is requested to review the proposed merge of lp:~zorba-coders/zorba/fix_xqdoc_oauth_module into lp:zorba/oauth-module.
=== modified file 'src/com/zorba-xquery/www/modules/oauth/client.xq' --- src/com/zorba-xquery/www/modules/oauth/client.xq 2012-04-12 08:45:03 +0000 +++ src/com/zorba-xquery/www/modules/oauth/client.xq 2012-04-24 20:55:43 +0000 @@ -92,6 +92,16 @@ : href="https://api.twitter.com/oauth/access_token"/> : </sp:service-provider> : </pre> + : @param $consumer-key Client Identifier, also known as the consumer-key + : @param $consumer-secret Client Shared-Secret, also known as the consumer-secret + : @param $signature-method Method with which the signing key is signed (typically HMAC-SHA1) + : @param $realm Realm that defines the protection space + : @param $authorize-url authorize-url + : @param $request-token-method request-token-method + : @param $request-token-url request-token-url + : @param $request-token-callback-url request-token-callback-url + : @param $access-token-method access-token-method + : @param $access-token-url access-token-url : @return instance of the OAuth service provider XML schema. :) declare function oauth:service-provider( @@ -137,6 +147,8 @@ : <p:parameter name="oauth_token" value="#" /> : </p:parameters> : </pre> + : @param $name parameter name + : @param $value parameter value : @return instance of the OAuth parameters XML schema. :) declare function oauth:parameters($name as xs:string, $value as xs:string) @@ -167,6 +179,9 @@ : <p:parameter name="oauth_token_secret" value="#" /> : </p:parameters> : </pre> + : @param $parameters parameters + : @param $name parameter name + : @param $value parameter value : @return instance of the OAuth parameters XML schema. :) declare function oauth:add-parameter($parameters as schema-element(p:parameters)?, $name as xs:string, $value as xs:string) @@ -276,6 +291,7 @@ : This function is provided for convenience. : @see http://tools.ietf.org/html/rfc5849#section-2.3 : @param $service-provider Contains service provider information + : @param $parameters parameters : @return token credentials correctly parsed as parameter elements, or an error if http response status is not 200 OK : : <pre class="ace-static" ace-mode="xquery"> @@ -318,7 +334,8 @@ : This function is provided for convenience. : @see http://tools.ietf.org/html/rfc5849#section-3 : @param $protected-resource (Not schema-validated) http:request element with http method and href. - : @param $request request element containing the client's request + : @param $service-provider Information about the service provider + : @param $parameters parameters : @return protected resources parsed as parameter elements, or an error if http response status is not 200 OK : : <pre class="ace-static" ace-mode="xquery"> === modified file 'src/com/zorba-xquery/www/modules/oauth/error.xq' --- src/com/zorba-xquery/www/modules/oauth/error.xq 2012-04-11 20:22:31 +0000 +++ src/com/zorba-xquery/www/modules/oauth/error.xq 2012-04-24 20:55:43 +0000 @@ -34,32 +34,26 @@ declare variable $oerr:errNS as xs:string := "http://www.zorba-xquery.com/modules/oauth/errors";; (:~ - : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'err:OC001'. This signing method is not implemented yet. + : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'OC001'. This signing method is not implemented yet. :) declare variable $oerr:OC001 as xs:QName := xs:QName("oerr:OC001"); (:~ - : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'err:OC002'. This signing method is not supported. + : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'OC002'. This signing method is not supported. :) declare variable $oerr:OC002 as xs:QName := xs:QName("oerr:OC002"); (:~ - : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'err:OC003'. Http 401 error. + : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'OC003'. Http 401 error. :) declare variable $oerr:OC003 as xs:QName := xs:QName("oerr:OC003"); (:~ - : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'err:OC004'. Http 500 error. + : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'OC004'. Http 500 error. :) declare variable $oerr:OC004 as xs:QName := xs:QName("oerr:OC004"); (:~ - : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'err:OC004'. Http 500 error. + : xs:QName with namespace URI="http://www.zorba-xquery.com/modules/oauth/errors"; and local name 'OC004'. Http 500 error. :) -declare variable $oerr:OC005 as xs:QName := xs:QName("oerr:OC005"); - -declare function oerr:handle($a, $b, $c, $d) -{ - ($a, $b, $c, $d) -}; - +declare variable $oerr:OC005 as xs:QName := xs:QName("oerr:OC005"); \ No newline at end of file
-- Mailing list: https://launchpad.net/~zorba-coders Post to : zorba-coders@lists.launchpad.net Unsubscribe : https://launchpad.net/~zorba-coders More help : https://help.launchpad.net/ListHelp
