Fix Doxygen warnings (#1270)

Add API doc to omit Doxygen errors.

Relates-To: OLPESGE-731
Signed-off-by: Halyna Dumych <[email protected]>

Author: HalynaDumych

olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationClient.h

@@ -286,10 +286,16 @@ class AUTHENTICATION_API AuthenticationClient {
   explicit AuthenticationClient(AuthenticationSettings settings);
   virtual ~AuthenticationClient();
 
-  // Non-copyable but movable
+  /// A copy constructor.
   AuthenticationClient(const AuthenticationClient&) = delete;
+
+  /// A copy assignment operator.
   AuthenticationClient& operator=(const AuthenticationClient&) = delete;
+
+  /// A default move constructor.
   AuthenticationClient(AuthenticationClient&&) noexcept;
+
+  /// A move assignment operator.
   AuthenticationClient& operator=(AuthenticationClient&&) noexcept;
 
   /**
@@ -437,7 +443,7 @@ class AUTHENTICATION_API AuthenticationClient {
    * @brief Signs in with your valid Apple token and requests your user access
    * token.
    *
-   * @param sign_in_properties The `AppleSignInProperties` instance.
+   * @param properties The `AppleSignInProperties` instance.
    * @param callback The `SignInUserCallback` method that is called when
    * the user sign-in request is completed. If successful, the returned HTTP
    * status is 200. If a new account is created as a part of the sign-in

olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationError.h

@@ -31,7 +31,7 @@ namespace authentication {
  * @brief Contains information on the authentication error.
  *
  * You can get the following information on the authentication error: the error
- * code ( \ref GetErrorCode ) and error message ( \ref GetMessage ).
+ * code (`GetErrorCode`) and error message (`GetMessage`).
  *
  * @deprecated Will be removed by 12.2020. Use `client::ApiError` instead.
  */

olp-cpp-sdk-authentication/include/olp/authentication/AuthorizeRequest.h

@@ -47,7 +47,7 @@ namespace authentication {
 class AUTHENTICATION_API AuthorizeRequest final {
  public:
   /**
-   * @brief The type alias for the action pair.
+   * @brief An alias for the action pair.
    *
    * The first parameter is the type of action.
    * The second one is optional and represents the resource.
@@ -58,7 +58,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
   using Action = std::pair<std::string, std::string>;
 
   /**
-   * @brief The type alias for the vector of actions.
+   * @brief An alias for the vector of actions.
    */
   using Actions = std::vector<Action>;
 

olp-cpp-sdk-authentication/include/olp/authentication/AuthorizeResult.h

@@ -41,7 +41,7 @@ class AUTHENTICATION_API Permission {
   /**
    * @brief Sets the action associated with the resource.
    *
-   * @param The action to associate with.
+   * @param action The action to associate with.
    */
   void SetAction(std::string action) { action_ = std::move(action); }
 
@@ -55,7 +55,7 @@ class AUTHENTICATION_API Permission {
   /**
    * @brief Sets the resource with which the action and decision are associated.
    *
-   * @param The resource to associate with the decision and action.
+   * @param resource The resource to associate with the decision and action.
    */
   void SetResource(std::string resource) { resource_ = std::move(resource); }
 
@@ -69,7 +69,7 @@ class AUTHENTICATION_API Permission {
   /**
    * @brief Sets the decision associated with the resource.
    *
-   * @param The decision to associate with the resource.
+   * @param decision The decision to associate with the resource.
    */
   void SetDecision(DecisionType decision) { decision_ = decision; }
 
@@ -107,7 +107,7 @@ class AUTHENTICATION_API ActionResult {
   /**
    * @brief Sets the policy decision.
    *
-   * @param The policy decision.
+   * @param decision The policy decision.
    */
   void SetDecision(DecisionType decision) { decision_ = decision; }
 
@@ -179,7 +179,7 @@ class AUTHENTICATION_API AuthorizeResult {
   /**
    * @brief Sets the client ID.
    *
-   * @param The client ID.
+   * @param client_id The client ID.
    */
   void SetClientId(std::string client_id) { client_id_ = std::move(client_id); }
 

olp-cpp-sdk-authentication/include/olp/authentication/AutoRefreshingToken.h

@@ -65,6 +65,7 @@ class AUTHENTICATION_API OLP_SDK_DEPRECATED("Will be removed by 10.2020.")
    * If no token has been retrieved yet or the current token is expired or
    * expires within five minutes, a new token is requested. Otherwise,
    * the cached token is returned. This method is thread-safe.
+   *
    * @note This method is blocked when a new token needs to be retrieved.
    * Therefore, the token should not be called from a time-sensitive thread (for
    * example, the UI thread).

olp-cpp-sdk-authentication/include/olp/authentication/Crypto.h

@@ -28,12 +28,13 @@
 namespace olp {
 namespace authentication {
 
-/**
- * @brief Crypto class exposes the cryptographic algoritms used by the library.
- */
+/// The cryptographic algoritms used by the library.
 class AUTHENTICATION_API Crypto {
  public:
+  /// The hash length after the SHA-256 encryption.
   static const size_t Sha256DigestLength = 32;
+
+  /// An alias for the hash.
   using Sha256Digest = std::array<unsigned char, Sha256DigestLength>;
 
   /**

olp-cpp-sdk-authentication/include/olp/authentication/TokenProvider.h

@@ -65,10 +65,16 @@ class TokenProvider {
       : impl_(std::make_shared<TokenProviderImpl>(
             std::move(settings), std::chrono::seconds(MinimumValidity))) {}
 
-  // Default copyable, default movable.
+  /// A default copy constructor.
   TokenProvider(const TokenProvider& other) = default;
+
+  /// A default move constructor.
   TokenProvider(TokenProvider&& other) noexcept = default;
+
+  /// A default copy assignment operator.
   TokenProvider& operator=(const TokenProvider& other) = default;
+
+  /// A default move assignment operator.
   TokenProvider& operator=(TokenProvider&& other) noexcept = default;
 
   /**

olp-cpp-sdk-authentication/include/olp/authentication/TokenRequest.h

@@ -36,7 +36,8 @@ class AUTHENTICATION_API OLP_SDK_DEPRECATED("Will be removed in 10.2020")
  public:
   /**
    * @brief Creates the `TokenRequest` instance.
-   * @param expiresIn (Optional) The number of seconds left before the new
+   *
+   * @param expires_in (Optional) The number of seconds left before the new
    * access token expires.
    */
   TokenRequest(

olp-cpp-sdk-authentication/include/olp/authentication/TokenResult.h

@@ -34,9 +34,9 @@ namespace authentication {
  * @brief A parsed response received from the OAuth2.0 token endpoint.
  *
  * You can get the following information: the access token issued by
- * the authorization server ( \ref GetAccessToken ), its expiry time
- * ( \ref GetExpiryTime ), HTTP status code ( \ref GetHttpStatus ),
- * and error description ( \ref GetErrorResponse ) in case of a failure.
+ * the authorization server (`GetAccessToken`), its expiry time
+ * (`GetExpiryTime`), HTTP status code (`GetHttpStatus`),
+ * and error description (`GetErrorResponse`) in case of a failure.
  */
 class AUTHENTICATION_API TokenResult {
  public:

olp-cpp-sdk-authentication/include/olp/authentication/UserAccountInfoResponse.h

@@ -263,7 +263,7 @@ class AUTHENTICATION_API UserAccountInfoResponse {
    * @brief Sets the timestamp (milliseconds since the Unix epoch) of when
    * the account was created.
    *
-   * @param time The epoch time when the account was created.
+   * @param created_time The epoch time when the account was created.
    */
   void SetCreatedTime(time_t created_time) { created_time_ = created_time; }