From 24c9d03edc23b8462eb259b20161d86ad5f950c3 Mon Sep 17 00:00:00 2001 From: Fabian Lupa Date: Sat, 15 Sep 2018 13:37:06 +0200 Subject: [PATCH] Update 2FA ABAP Doc comments Fixes #1924 --- src/http/zcl_abapgit_2fa_auth_base.clas.abap | 4 +-- .../zcl_abapgit_2fa_auth_registry.clas.abap | 6 ++-- .../zif_abapgit_2fa_authenticator.intf.abap | 31 +++++++++---------- 3 files changed, 20 insertions(+), 21 deletions(-) diff --git a/src/http/zcl_abapgit_2fa_auth_base.clas.abap b/src/http/zcl_abapgit_2fa_auth_base.clas.abap index ca1fac782..61d7713ba 100644 --- a/src/http/zcl_abapgit_2fa_auth_base.clas.abap +++ b/src/http/zcl_abapgit_2fa_auth_base.clas.abap @@ -1,4 +1,4 @@ -"! Default LIF_2FA-AUTHENTICATOR implememtation +"! Default {@link ZIF_ABAPGIT_2FA_AUTHENTICATOR} implementation CLASS zcl_abapgit_2fa_auth_base DEFINITION PUBLIC ABSTRACT @@ -17,7 +17,7 @@ CLASS zcl_abapgit_2fa_auth_base DEFINITION METHODS: "! @parameter iv_supported_url_regex | Regular expression to check if a repository url is "! supported, used for default implementation of - "! SUPPORTS_URL + "! {@link .METH:supports_url} constructor IMPORTING iv_supported_url_regex TYPE clike. PROTECTED SECTION. CLASS-METHODS: diff --git a/src/http/zcl_abapgit_2fa_auth_registry.clas.abap b/src/http/zcl_abapgit_2fa_auth_registry.clas.abap index 247d7e358..e939f4fb3 100644 --- a/src/http/zcl_abapgit_2fa_auth_registry.clas.abap +++ b/src/http/zcl_abapgit_2fa_auth_registry.clas.abap @@ -1,4 +1,4 @@ -"! Static registry class to find LIF_2FA_AUTHENTICATOR instances +"! Static registry class to find {@link ZIF_ABAPGIT_2FA_AUTHENTICATOR} instances CLASS zcl_abapgit_2fa_auth_registry DEFINITION PUBLIC FINAL @@ -9,8 +9,8 @@ CLASS zcl_abapgit_2fa_auth_registry DEFINITION class_constructor, "! Retrieve an authenticator instance by url "! @parameter iv_url | Url of the repository / service - "! @parameter ro_authenticator | Found authenticator instance - "! @raising lcx_2fa_unsupported | No authenticator found that supports the service + "! @parameter ri_authenticator | Found authenticator instance + "! @raising zcx_abapgit_2fa_unsupported | No authenticator found that supports the service get_authenticator_for_url IMPORTING iv_url TYPE string RETURNING VALUE(ri_authenticator) TYPE REF TO zif_abapgit_2fa_authenticator RAISING zcx_abapgit_2fa_unsupported, diff --git a/src/http/zif_abapgit_2fa_authenticator.intf.abap b/src/http/zif_abapgit_2fa_authenticator.intf.abap index 4a99bc5a6..94ff517db 100644 --- a/src/http/zif_abapgit_2fa_authenticator.intf.abap +++ b/src/http/zif_abapgit_2fa_authenticator.intf.abap @@ -6,27 +6,26 @@ "! implementation of the git http api, just like the "normal" password would. "!

"!

-"! LCL_2FA_AUTHENTICATOR_REGISTRY can be used to find a suitable implementation for a given -"! repository. +"! {@link ZCL_ABAPGIT_2FA_AUTH_REGISTRY} can be used to find a suitable implementation for a +"! given repository. "!

"!

-"! Using the begin and end methods an internal session can be started and +"! Using the {@link zif_abapgit_2fa_authenticator.METH:begin} and +"! {@link zif_abapgit_2fa_authenticator.METH.end} methods an internal session can be started and "! completed in which internal state necessary for multiple methods will be cached. This can be -"! used to avoid having multiple http sessions between authenticate and -"! delete_access_tokens. +"! used to avoid having multiple http sessions between +"! {@link zif_abapgit_2fa_authenticator.METH:authenticate} and +"! {@link zif_abapgit_2fa_authenticator.METH:delete_access_tokens}. "!

-INTERFACE zif_abapgit_2fa_authenticator - PUBLIC . - - +INTERFACE zif_abapgit_2fa_authenticator PUBLIC. "! Generate an access token "! @parameter iv_url | Repository url "! @parameter iv_username | Username "! @parameter iv_password | Password "! @parameter iv_2fa_token | Two factor token "! @parameter rv_access_token | Generated access token - "! @raising lcx_2fa_auth_failed | Authentication failed - "! @raising lcx_2fa_token_gen_failed | Token generation failed + "! @raising zcx_abapgit_2fa_auth_failed | Authentication failed + "! @raising zcx_abapgit_2fa_gen_failed | Token generation failed METHODS authenticate IMPORTING !iv_url TYPE string @@ -39,7 +38,7 @@ INTERFACE zif_abapgit_2fa_authenticator zcx_abapgit_2fa_auth_failed zcx_abapgit_2fa_gen_failed zcx_abapgit_2fa_comm_error . - "! Check if this authenticator instance supports the give repository url + "! Check if this authenticator instance supports the given repository url "! @parameter iv_url | Repository url "! @parameter rv_supported | Is supported METHODS supports_url @@ -66,8 +65,8 @@ INTERFACE zif_abapgit_2fa_authenticator "! @parameter iv_username | Username "! @parameter iv_password | Password "! @parameter iv_2fa_token | Two factor token - "! @raising lcx_2fa_token_del_failed | Token deletion failed - "! @raising lcx_2fa_auth_failed | Authentication failed + "! @raising zcx_abapgit_2fa_del_failed | Token deletion failed + "! @raising zcx_abapgit_2fa_auth_failed | Authentication failed METHODS delete_access_tokens IMPORTING !iv_url TYPE string @@ -79,12 +78,12 @@ INTERFACE zif_abapgit_2fa_authenticator zcx_abapgit_2fa_comm_error zcx_abapgit_2fa_auth_failed . "! Begin an authenticator session that uses internal caching for authorizations - "! @raising lcx_2fa_illegal_state | Session already started + "! @raising zcx_abapgit_2fa_illegal_state | Session already started METHODS begin RAISING zcx_abapgit_2fa_illegal_state . "! End an authenticator session and clear internal caches - "! @raising lcx_2fa_illegal_state | Session not running + "! @raising zcx_abapgit_2fa_illegal_state | Session not running METHODS end RAISING zcx_abapgit_2fa_illegal_state .