Documentation fixes

* Do not use @see inside other tags
* Add missing parenthesis

Change-Id: I4b7492eb410c6f510b6848689faf622dd0b8dc5b

diff --git a/src/include/ckmc/ckmc-manager.h b/src/include/ckmc/ckmc-manager.h
index f4db37f..35d021c 100644 (file)
--- a/src/include/ckmc/ckmc-manager.h
+++ b/src/include/ckmc/ckmc-manager.h
@@ -1003,9 +1003,8 @@ int ckmc_remove_alias(const char *alias);
  * @param[in] password The password used in decrypting a key value. If password of the policy is
  *                     provided in ckmc_save_key(), the same password should be provided
  * @param[in] decrypted Data to be encrypted. In case of AES algorithm the backend may impose limit
- *                      on the maximum size of processed data
- *                      (@see ckmc_backend_get_max_chunk_size()). For RSA the size must be smaller
- *                      or equal to key size in bytes - 42.
+ *                      on the maximum size of processed data (ckmc_backend_get_max_chunk_size()).
+ *                      For RSA the size must be smaller or equal to key size in bytes - 42.
  *                      Example: for 1024 RSA key the maximum data size is 1024/8 - 42 = 86.
  * @param[out] ppencrypted Encrypted data. In #CKMC_ALGO_AES_GCM mode it includes the GCM tag
  *                         appended at the end.
@@ -1063,9 +1062,8 @@ int ckmc_encrypt_data(ckmc_param_list_h params,
  *                     provided in ckmc_save_key(), the same password should be provided
  * @param[in] encrypted Data to be decrypted. #CKMC_ALGO_AES_GCM mode requires GCM tag to be
  *                      appended at the end. In case of AES algorithm the backend may impose limit
- *                      on the maximum size of processed data
- *                      (@see ckmc_backend_get_max_chunk_size()). For RSA the size must be smaller
- *                      or equal to key size in bytes - 42.
+ *                      on the maximum size of processed data (ckmc_backend_get_max_chunk_size()).
+ *                      For RSA the size must be smaller or equal to key size in bytes - 42.
  * @param[out] ppdecrypted Decrypted data
  *
  * @return @c 0 on success, otherwise a negative error value
@@ -1115,7 +1113,7 @@ int ckmc_decrypt_data(ckmc_param_list_h params,
  * @remarks If extractable in @a policy is set to false, the stored key may still be exported in a
  *          wrapped form.
  * @remarks Note that the backend may impose limit on the maximum size of @a wrapped_key
- *          (@see ckmc_backend_get_max_chunk_size()).
+ *          (ckmc_backend_get_max_chunk_size()).
  *
  * @param[in] params Algorithm parameter list handle. See #ckmc_param_list_h and #ckmc_algo_type_e
  *                   for details. Supported algorithms:
@@ -1323,7 +1321,7 @@ int ckmc_cipher_initialize(ckmc_param_list_h params,
  * @remarks The newly created @a ppout must be destroyed using ckmc_buffer_free() when it's no
  *          longer needed.
  * @remarks Note that the backend may impose limit on the maximum size of processed data
- *          (@see ckmc_backend_get_max_chunk_size()).
+ *          (ckmc_backend_get_max_chunk_size()).
  *
  * @param[in] context Encryption/decryption context created with ckmc_cipher_initialize()
  * @param[in] in Encryption/decryption input

diff --git a/src/include/ckmc/ckmc-type.h b/src/include/ckmc/ckmc-type.h
index 7275776..c3240e8 100644 (file)
--- a/src/include/ckmc/ckmc-type.h
+++ b/src/include/ckmc/ckmc-type.h
@@ -121,7 +121,7 @@ typedef enum __ckmc_ec_type {
        CKMC_EC_PRIME192V1 = 0, /**< Elliptic curve domain "secp192r1" listed in "SEC 2" recommended
                             elliptic curve domain */
        CKMC_EC_PRIME256V1, /**< "SEC 2" recommended elliptic curve domain - secp256r1 */
-       CKMC_EC_SECP384R1 /**< NIST curve P-384(covers "secp384r1", the elliptic curve domain
+       CKMC_EC_SECP384R1 /**< NIST curve P-384 (covers "secp384r1"), the elliptic curve domain
                       listed in See SEC 2 */
 } ckmc_ec_type_e;
 
@@ -420,14 +420,13 @@ typedef enum __ckmc_algo_type {
                        - #CKMC_PARAM_ALGO_TYPE = #CKMC_ALGO_AES_GCM (mandatory),
                        - #CKMC_PARAM_ED_IV = 1 to (2^64-1) bytes long initialization vector.
                        Note that the backend may impose additional limit on the maximum size
-                       (@see ckmc_backend_get_max_chunk_size()). Recommended length is 12B
-                       (mandatory)
+                       (ckmc_backend_get_max_chunk_size()). Recommended length is 12B (mandatory)
                        - #CKMC_PARAM_ED_TAG_LEN = GCM tag length in bits. One of
                        {32, 64, 96, 104, 112, 120, 128} (optional, if not present, the
                        length 128 is used; since Tizen 5.0, if TrustZone backend is used,
                        32 and 64 lengths are not supported)
                        - #CKMC_PARAM_ED_AAD = additional authentication data. Note that the backend
-                       may impose limit on the maximum size (@see ckmc_backend_get_max_chunk_size())
+                       may impose limit on the maximum size (ckmc_backend_get_max_chunk_size())
                        (optional) */
 
        CKMC_ALGO_AES_CFB, /**< AES-CFB algorithm