res: Fix for Doxygen.

These are the remaining issues found in /res.

ASTERISK-29761

Change-Id: I572e6019c422780dde5ce8448b6c85c77af6046d
This commit is contained in:
Alexander Traud
2021-11-19 10:11:08 +01:00
committed by Friendly Automation
parent 3162f6dfdd
commit 14736ae6d4
32 changed files with 104 additions and 147 deletions

View File

@@ -27,10 +27,10 @@ struct stir_shaken_certificate;
/*!
* \brief Get a STIR/SHAKEN certificate by caller ID number
*
* \param callier_id_number The caller ID number
* \param caller_id_number The caller ID number
*
* \retval NULL if not found
* \retval The certificate on success
* \return The certificate on success
*/
struct stir_shaken_certificate *stir_shaken_certificate_get_by_caller_id_number(const char *caller_id_number);
@@ -40,7 +40,7 @@ struct stir_shaken_certificate *stir_shaken_certificate_get_by_caller_id_number(
* \param cert The certificate to get the public key URL from
*
* \retval NULL on failure
* \retval The public key URL on success
* \return The public key URL on success
*/
const char *stir_shaken_certificate_get_public_cert_url(struct stir_shaken_certificate *cert);
@@ -60,7 +60,7 @@ const char *stir_shaken_certificate_get_attestation(struct stir_shaken_certifica
* \param cert The certificate to get the private key from
*
* \retval NULL on failure
* \retval The private key on success
* \return The private key on success
*/
EVP_PKEY *stir_shaken_certificate_get_private_key(struct stir_shaken_certificate *cert);
@@ -94,14 +94,16 @@ int test_stir_shaken_create_cert(const char *caller_id_number, const char *file_
/*!
* \brief Load time initialization for the stir/shaken 'certificate' configuration
*
* \retval 0 on success, -1 on error
* \retval 0 on success
* \retval -1 on error
*/
int stir_shaken_certificate_load(void);
/*!
* \brief Unload time cleanup for the stir/shaken 'certificate' configuration
*
* \retval 0 on success, -1 on error
* \retval 0 on success
* \retval -1 on error
*/
int stir_shaken_certificate_unload(void);

View File

@@ -81,6 +81,7 @@ char *curl_cb_data_get_expires(const struct curl_cb_data *data)
/*!
* \brief Called when a CURL request completes
*
* \param buffer, size, nitems
* \param data The curl_cb_data structure to store expiration info
*/
static size_t curl_header_callback(char *buffer, size_t size, size_t nitems, void *data)
@@ -123,7 +124,7 @@ static size_t curl_header_callback(char *buffer, size_t size, size_t nitems, voi
* \param data The CURL callback data
*
* \retval NULL on failure
* \retval CURL instance on success
* \return CURL instance on success
*/
static CURL *get_curl_instance(struct curl_cb_data *data)
{
@@ -159,7 +160,7 @@ static CURL *get_curl_instance(struct curl_cb_data *data)
* \param filename Function allocates memory and stores full filename (including path) here
*
* \retval -1 on failure
* \retval file descriptor on success
* \return file descriptor on success
*/
static int create_temp_file(const char *path, char **filename)
{