res_ari: Fix for Doxygen.

ASTERISK-29756

Change-Id: I2f1c1eea1c902492b77b74de9950f20ebbb7e758

rest-api-templates/ari_model_validators.h.mustache

@@ -46,8 +46,8 @@
  * \brief Validator for native Swagger void.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_void(struct ast_json *json);
 
@@ -55,8 +55,8 @@ int ast_ari_validate_void(struct ast_json *json);
  * \brief Validator for native Swagger object.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_object(struct ast_json *json);
 
@@ -64,8 +64,8 @@ int ast_ari_validate_object(struct ast_json *json);
  * \brief Validator for native Swagger byte.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_byte(struct ast_json *json);
 
@@ -73,8 +73,8 @@ int ast_ari_validate_byte(struct ast_json *json);
  * \brief Validator for native Swagger boolean.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_boolean(struct ast_json *json);
 
@@ -82,8 +82,8 @@ int ast_ari_validate_boolean(struct ast_json *json);
  * \brief Validator for native Swagger int.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_int(struct ast_json *json);
 
@@ -91,8 +91,8 @@ int ast_ari_validate_int(struct ast_json *json);
  * \brief Validator for native Swagger long.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_long(struct ast_json *json);
 
@@ -100,8 +100,8 @@ int ast_ari_validate_long(struct ast_json *json);
  * \brief Validator for native Swagger float.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_float(struct ast_json *json);
 
@@ -109,8 +109,8 @@ int ast_ari_validate_float(struct ast_json *json);
  * \brief Validator for native Swagger double.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_double(struct ast_json *json);
 
@@ -118,8 +118,8 @@ int ast_ari_validate_double(struct ast_json *json);
  * \brief Validator for native Swagger string.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_string(struct ast_json *json);
 
@@ -127,8 +127,8 @@ int ast_ari_validate_string(struct ast_json *json);
  * \brief Validator for native Swagger date.
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_date(struct ast_json *json);
 
@@ -137,8 +137,8 @@ int ast_ari_validate_date(struct ast_json *json);
  *
  * \param json JSON object to validate.
  * \param fn Validator to call on every element in the array.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_list(struct ast_json *json, int (*fn)(struct ast_json *));
 
@@ -158,15 +158,13 @@ typedef int (*ari_validator)(struct ast_json *json);
  * {{{description_dox}}}
  *
  * \param json JSON object to validate.
- * \returns True (non-zero) if valid.
- * \returns False (zero) if invalid.
+ * \retval True (non-zero) if valid.
+ * \retval False (zero) if invalid.
  */
 int ast_ari_validate_{{c_id}}(struct ast_json *json);
 
 /*!
  * \brief Function pointer to ast_ari_validate_{{c_id}}().
- *
- * See \ref ast_ari_model_validators.h for more details.
  */
 ari_validator ast_ari_validate_{{c_id}}_fn(void);
 {{/models}}

rest-api-templates/ari_resource.h.mustache

@@ -116,8 +116,6 @@ int ast_ari_websocket_{{c_name}}_{{c_nickname}}_init(void);
  *
  * {{{notes}}}
 {{/notes}}
- *
- * \return Nothing
  */
 void ast_ari_websocket_{{c_name}}_{{c_nickname}}_dtor(void);
 
@@ -149,7 +147,6 @@ int ast_ari_websocket_{{c_name}}_{{c_nickname}}_attempted(struct ast_tcptls_sess
  * \param session ARI WebSocket.
  * \param headers HTTP headers.
  * \param args Swagger parameters.
- * \param session_id The id of the current session.
  */
 void ast_ari_websocket_{{c_name}}_{{c_nickname}}_established(struct ast_ari_websocket_session *session,
 	struct ast_variable *headers, struct ast_ari_{{c_name}}_{{c_nickname}}_args *args);

rest-api-templates/res_ari_resource.c.mustache

@@ -71,9 +71,11 @@
 {{> body_parsing}}
 /*!
  * \brief Parameter parsing callback for {{path}}.
+ * \param ser TCP/TLS session object
  * \param get_params GET parameters in the HTTP request.
  * \param path_vars Path variables extracted from the request.
  * \param headers HTTP headers.
+ * \param body
  * \param[out] response Response to the HTTP request.
  */
 static void ast_ari_{{c_name}}_{{c_nickname}}_cb(