Merge pull request #59 from xuwei-k/scaladoc

use scaladoc wiki syntax

Author: tsuyoshizawa

play2-oauth2-provider/src/main/scala/scalaoauth2/provider/OAuth2Provider.scala

@@ -79,21 +79,21 @@ trait OAuth2BaseProvider extends Results {
  * OAuth2Provider supports issue access token and authorize.
  *
  * <h3>Create controller for issue access token</h3>
- * <code>
+ * @example {{{
  * object OAuth2Controller extends Controller with OAuth2Provider {
  *   def accessToken = Action.async { implicit request =>
  *     issueAccessToken(new MyDataHandler())
  *   }
  * }
- * </code>
+ * }}}
  *
  * <h3>Register routes</h3>
- * <code>
+ * @example {{{
  * POST /oauth2/access_token controllers.OAuth2Controller.accessToken
- * </code>
+ * }}}
  *
  * <h3>Authorized</h3>
- * <code>
+ * @example {{{
  * import scalaoauth2.provider._
  * object BookController extends Controller with OAuthProvider {
  *   def list = Action.async { implicit request =>
@@ -103,7 +103,7 @@ trait OAuth2BaseProvider extends Results {
  *     }
  *   }
  * }
- * </code>
+ * }}}
  */
 trait OAuth2Provider extends OAuth2BaseProvider {
 
@@ -152,21 +152,21 @@ trait OAuth2Provider extends OAuth2BaseProvider {
  * OAuth2AsyncProvider supports issue access token and authorize in asynchronous.
  *
  * <h3>Create controller for issue access token</h3>
- * <code>
+ * @example {{{
  * object OAuth2Controller extends Controller with OAuth2AsyncProvider {
  *   def accessToken = Action.async { implicit request =>
  *     issueAccessToken(new MyDataHandler())
  *   }
  * }
- * </code>
+ * }}}
  *
  * <h3>Register routes</h3>
- * <code>
+ * @example {{{
  * POST /oauth2/access_token controllers.OAuth2Controller.accessToken
- * </code>
+ * }}}
  *
  * <h3>Authorized</h3>
- * <code>
+ * @example {{{
  * import scalaoauth2.provider._
  * object BookController extends Controller with OAuth2AsyncProvider {
  *   def list = Action.async { implicit request =>
@@ -176,7 +176,7 @@ trait OAuth2Provider extends OAuth2BaseProvider {
  *     }
  *   }
  * }
- * </code>
+ * }}}
  */
 @deprecated("Use OAuth2Provider", "0.12.0")
 trait OAuth2AsyncProvider extends OAuth2Provider

play2-oauth2-provider/src/main/scala/scalaoauth2/provider/package.scala

@@ -11,22 +11,22 @@ package object provider {
    * Support synchronous Result for Playframework
    *
    * <h3>Create controller for issue access token</h3>
-   * <code>
+   * @example {{{
    * import scalaoauth2.provider._
    * object OAuth2Controller extends Controller with OAuth2Provider {
    *   def accessToken = Action { implicit request =>
    *     await(issueAccessToken(new MyDataHandler()))
    *   }
    * }
-   * </code>
+   * }}}
    *
    * <h3>Register routes</h3>
-   * <code>
+   * @example {{{
    * POST /oauth2/access_token controllers.OAuth2Controller.accessToken
-   * </code>
+   * }}}
    *
    * <h3>Authorized</h3>
-   * <code>
+   * @example {{{
    * import scalaoauth2.provider._
    * object BookController extends Controller with OAuthProvider {
    *   def list = Action { implicit request =>
@@ -37,7 +37,7 @@ package object provider {
    *     })
    *   }
    * }
-   * </code>
+   * }}}
    * @param f callback
    * @param timeout maximum wait time
    * @return Await and return the result.