Add missing declarations to the API document

PSA_KEY_ATTRIBUTES_INIT and psa_key_attributes_init weren't declared
in the API document, only defined in our implementation, but they are
referenced in the API document.
This commit is contained in:
Gilles Peskine 2019-05-21 15:54:54 +02:00
parent fba7539ad7
commit a0c0655c91

View file

@ -204,6 +204,22 @@ psa_status_t psa_crypto_init(void);
*/ */
typedef struct psa_key_attributes_s psa_key_attributes_t; typedef struct psa_key_attributes_s psa_key_attributes_t;
/** \def PSA_KEY_ATTRIBUTES_INIT
*
* This macro returns a suitable initializer for a key attribute structure
* of type #psa_key_attributes_t.
*/
#ifdef __DOXYGEN_ONLY__
/* This is an example definition for documentation purposes.
* Implementations should define a suitable value in `crypto_struct.h`.
*/
#define PSA_KEY_ATTRIBUTES_INIT {0}
#endif
/** Return an initial value for a key attributes structure.
*/
static psa_key_attributes_t psa_key_attributes_init(void);
/** Declare a key as persistent and set its key identifier. /** Declare a key as persistent and set its key identifier.
* *
* If the attribute structure currently declares the key as volatile (which * If the attribute structure currently declares the key as volatile (which