progdocs: Fix Doxygen left-overs.

Change-Id: I5b5cf9c9cbbe00ba8b379a8d162ac67445d39016

include/asterisk/cdr.h

@@ -494,7 +494,6 @@ struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr);
 /*!
  * \brief Free a CDR record
  * \param cdr ast_cdr structure to free
- * Returns nothing
  */
 void ast_cdr_free(struct ast_cdr *cdr);
 

include/asterisk/channel.h

@@ -4504,7 +4504,7 @@ void ast_channel_set_manager_vars(size_t varc, char **vars);
  *
  * \param chan Channel to get variables for.
  * \return List of channel variables.
- * \return \c NULL on error
+ * \retval NULL on error
  */
 struct varshead *ast_channel_get_manager_vars(struct ast_channel *chan);
 
@@ -4534,7 +4534,7 @@ void ast_channel_set_ari_vars(size_t varc, char **vars);
  *
  * \param chan Channel to get variables for.
  * \return List of channel variables.
- * \return \c NULL on error
+ * \retval NULL on error
  */
 struct varshead *ast_channel_get_ari_vars(struct ast_channel *chan);
 
@@ -4546,7 +4546,7 @@ struct varshead *ast_channel_get_ari_vars(struct ast_channel *chan);
  *
  * \param chan Channel to get variables for
  * \return List of channel variables.
- * \return \c NULL on error
+ * \retval NULL on error
  */
 struct varshead *ast_channel_get_vars(struct ast_channel *chan);
 

include/asterisk/conversions.h

@@ -37,7 +37,7 @@
  *       or greater than INT_MAX)
  *
  * \param str The string to convert
- * \param res [out] The converted value
+ * \param[out] res The converted value
  *
  * \returns -1 if it fails to convert, 0 on success
  */
@@ -55,7 +55,7 @@ int ast_str_to_int(const char *str, int *res);
  *   Once converted the number is out of range (greater than UINT_MAX)
  *
  * \param str The string to convert
- * \param res [out] The converted value
+ * \param[out] res The converted value
  *
  * \returns -1 if it fails to convert, 0 on success
  */
@@ -73,7 +73,7 @@ int ast_str_to_uint(const char *str, unsigned int *res);
  *       or greater than LONG_MAX)
  *
  * \param str The string to convert
- * \param res [out] The converted value
+ * \param[out] res The converted value
  *
  * \returns -1 if it fails to convert, 0 on success
  */
@@ -91,7 +91,7 @@ int ast_str_to_long(const char *str, long *res);
  *   Once converted the number is out of range (greater than ULONG_MAX)
  *
  * \param str The string to convert
- * \param res [out] The converted value
+ * \param[out] res The converted value
  *
  * \returns -1 if it fails to convert, 0 on success
  */
@@ -109,7 +109,7 @@ int ast_str_to_ulong(const char *str, unsigned long *res);
  *       or greater than INTMAX_MAX)
  *
  * \param str The string to convert
- * \param res [out] The converted value
+ * \param[out] res The converted value
  *
  * \returns -1 if it fails to convert, 0 on success
  */
@@ -127,7 +127,7 @@ int ast_str_to_imax(const char *str, intmax_t *res);
  *   Once converted the number is out of range (greater than UINTMAX_MAX)
  *
  * \param str The string to convert
- * \param res [out] The converted value
+ * \param[out] res The converted value
  *
  * \returns -1 if it fails to convert, 0 on success
  */

include/asterisk/core_local.h

@@ -51,9 +51,9 @@ struct stasis_message_type;
  * \since 13.17.0, 14.6.0
  *
  * \param chan Must be a local channel
- * \param tech_pvt [out] channel's private tech (ref and lock added)
- * \param base_chan [out] One side of the local channel (ref and lock added)
- * \param base_owner [out] Other side of the local channel (ref and lock added)
+ * \param[out] tech_pvt channel's private tech (ref and lock added)
+ * \param[out] base_chan One side of the local channel (ref and lock added)
+ * \param[out] base_owner Other side of the local channel (ref and lock added)
  */
 void ast_local_lock_all(struct ast_channel *chan, void **tech_pvt,
 	struct ast_channel **base_chan, struct ast_channel **base_owner);

include/asterisk/endpoints.h

@@ -62,7 +62,7 @@ enum ast_endpoint_state {
  *
  * \param state Endpoint state.
  * \return String representation of \a state.
- * \return \c "?" if \a state isn't in \ref ast_endpoint_state.
+ * \retval "?" if \a state isn't in \ref ast_endpoint_state.
  */
 const char *ast_endpoint_state_to_string(enum ast_endpoint_state state);
 
@@ -89,7 +89,7 @@ struct ast_endpoint;
  *
  * \param id Tech[/resource] id to look for.
  * \return Associated endpoint.
- * \return \c NULL if not found.
+ * \retval NULL if not found.
  *
  * \since 12
  */
@@ -106,7 +106,7 @@ struct ast_endpoint *ast_endpoint_find_by_id(const char *id);
  * \param tech Technology for this endpoint.
  * \param resource Name of this endpoint.
  * \return Newly created endpoint.
- * \return \c NULL on error.
+ * \retval NULL on error.
  * \since 12
  */
 struct ast_endpoint *ast_endpoint_create(const char *tech, const char *resource);
@@ -127,7 +127,7 @@ void ast_endpoint_shutdown(struct ast_endpoint *endpoint);
  *
  * \param endpoint The endpoint.
  * \return Tec of the endpoint.
- * \return \c NULL if endpoint is \c NULL.
+ * \retval NULL if endpoint is \c NULL.
  * \since 12
  */
 const char *ast_endpoint_get_tech(const struct ast_endpoint *endpoint);
@@ -142,7 +142,7 @@ const char *ast_endpoint_get_tech(const struct ast_endpoint *endpoint);
  *
  * \param endpoint The endpoint.
  * \return Resource name of the endpoint.
- * \return \c NULL if endpoint is \c NULL.
+ * \retval NULL if endpoint is \c NULL.
  * \since 12
  */
 const char *ast_endpoint_get_resource(const struct ast_endpoint *endpoint);
@@ -154,7 +154,7 @@ const char *ast_endpoint_get_resource(const struct ast_endpoint *endpoint);
  *
  * \param endpoint The endpoint.
  * \return Tech/resource id of the endpoint.
- * \return \c NULL if endpoint is \c NULL.
+ * \retval NULL if endpoint is \c NULL.
  * \since 12
  */
 const char *ast_endpoint_get_id(const struct ast_endpoint *endpoint);
@@ -164,7 +164,7 @@ const char *ast_endpoint_get_id(const struct ast_endpoint *endpoint);
  *
  * \param endpoint The endpoint.
  * \return state.
- * \return \c AST_ENDPOINT_UNKNOWN if endpoint is \c NULL.
+ * \retval AST_ENDPOINT_UNKNOWN if endpoint is \c NULL.
  * \since 13.4
  */
 enum ast_endpoint_state ast_endpoint_get_state(const struct ast_endpoint *endpoint);

include/asterisk/http.h

@@ -311,8 +311,8 @@ int ast_http_response_status_line(const char *buf, const char *version, int code
  *       respectively.
  *
  * \param buf a string containing the name/value to point to
- * \param name out parameter pointing to the header name
- * \param value out parameter pointing to header value
+ * \param[out] name header name
+ * \param[out] value header value
  * \retval -1 if buf is empty
  * \retval 0 if buf could be separated into name and value
  * \retval 1 if name or value portion don't exist

include/asterisk/image.h

@@ -76,7 +76,6 @@ int ast_image_register(struct ast_imager *imgdrv);
  * \brief Unregister an image format
  * \param imgdrv pointer to the ast_imager structure you wish to unregister
  * Unregisters the image format passed in.
- * Returns nothing
  */
 void ast_image_unregister(struct ast_imager *imgdrv);
 

include/asterisk/stasis_app_device_state.h

@@ -39,7 +39,7 @@
  * \param name the name of the device
  * \param state the device state
  * \return JSON representation.
- * \return \c NULL on error.
+ * \retval NULL on error.
  */
 struct ast_json *stasis_app_device_state_to_json(
 	const char *name, enum ast_device_state state);
@@ -48,7 +48,7 @@ struct ast_json *stasis_app_device_state_to_json(
  * \brief Convert device states to json array.
  *
  * \return JSON representation.
- * \return \c NULL on error.
+ * \retval NULL on error.
  */
 struct ast_json *stasis_app_device_states_to_json(void);
 

include/asterisk/stasis_cache_pattern.h

@@ -55,7 +55,7 @@ struct stasis_cp_all;
  * \param name Base name of the topics.
  * \param id_fn Identity function for the cache.
  * \return All side instance.
- * \return \c NULL on error.
+ * \retval NULL on error.
  */
 struct stasis_cp_all *stasis_cp_all_create(const char *name,
 	snapshot_get_id id_fn);
@@ -68,7 +68,7 @@ struct stasis_cp_all *stasis_cp_all_create(const char *name,
  *
  * \param all All side caching pattern object.
  * \return The aggregate topic.
- * \return \c NULL if \a all is \c NULL
+ * \retval NULL if \a all is \c NULL
  */
 struct stasis_topic *stasis_cp_all_topic(struct stasis_cp_all *all);
 
@@ -83,7 +83,7 @@ struct stasis_topic *stasis_cp_all_topic(struct stasis_cp_all *all);
  *
  * \param all All side caching pattern object.
  * \return The aggregate caching topic.
- * \return \c NULL if \a all is \c NULL
+ * \retval NULL if \a all is \c NULL
  */
 struct stasis_topic *stasis_cp_all_topic_cached(
 	struct stasis_cp_all *all);
@@ -95,7 +95,7 @@ struct stasis_topic *stasis_cp_all_topic_cached(
  *
  * \param all All side caching pattern object.
  * \return The cache.
- * \return \c NULL if \a all is \c NULL
+ * \retval NULL if \a all is \c NULL
  */
 struct stasis_cache *stasis_cp_all_cache(struct stasis_cp_all *all);
 
@@ -152,7 +152,7 @@ void stasis_cp_single_unsubscribe(struct stasis_cp_single *one);
  *
  * \param one One side of the cache pattern.
  * \return The main topic.
- * \return \c NULL if \a one is \c NULL
+ * \retval NULL if \a one is \c NULL
  */
 struct stasis_topic *stasis_cp_single_topic(struct stasis_cp_single *one);
 
@@ -164,7 +164,7 @@ struct stasis_topic *stasis_cp_single_topic(struct stasis_cp_single *one);
  *
  * \param one One side of the cache pattern.
  * \return The caching topic.
- * \return \c NULL if \a one is \c NULL
+ * \retval NULL if \a one is \c NULL
  */
 struct stasis_topic *stasis_cp_single_topic_cached(
 	struct stasis_cp_single *one);

include/asterisk/stasis_endpoints.h

@@ -91,7 +91,7 @@ struct ast_endpoint_blob {
  *             \c NULL, ast_json_null() is put into the object.
  *
  * \return \ref ast_endpoint_blob message.
- * \return \c NULL on error
+ * \retval NULL on error
  */
 struct stasis_message *ast_endpoint_blob_create(struct ast_endpoint *endpoint,
 	struct stasis_message_type *type, struct ast_json *blob);
@@ -133,7 +133,7 @@ struct stasis_message_type *ast_endpoint_snapshot_type(void);
  * \brief Create a snapshot of an endpoint
  * \param endpoint Endpoint to snap a shot of.
  * \return Snapshot of the endpoint.
- * \return \c NULL on error.
+ * \retval NULL on error.
  * \since 12
  */
 struct ast_endpoint_snapshot *ast_endpoint_snapshot_create(
@@ -200,7 +200,7 @@ struct stasis_cache *ast_endpoint_cache(void);
  * \param tech Name of the endpoint's technology.
  * \param resource Resource name of the endpoint.
  * \return Snapshot of the endpoint with the given name.
- * \return \c NULL if endpoint is not found, or on error.
+ * \retval NULL if endpoint is not found, or on error.
  * \since 12
  */
 struct ast_endpoint_snapshot *ast_endpoint_latest_snapshot(const char *tech,
@@ -216,7 +216,7 @@ struct ast_endpoint_snapshot *ast_endpoint_latest_snapshot(const char *tech,
  * \param sanitize The message sanitizer to use on the snapshot
  *
  * \return JSON object representing endpoint snapshot.
- * \return \c NULL on error
+ * \retval NULL on error
  */
 struct ast_json *ast_endpoint_snapshot_to_json(
 	const struct ast_endpoint_snapshot *snapshot,

include/asterisk/stasis_internal.h

@@ -58,7 +58,7 @@
  *  relevant if \c needs_mailbox is non-zero.
  * \param file, lineno, func
  * \return New \ref stasis_subscription object.
- * \return \c NULL on error.
+ * \retval NULL on error.
  * \since 12
  */
 struct stasis_subscription *internal_stasis_subscribe(

include/asterisk/threadpool.h

@@ -259,7 +259,7 @@ struct ast_taskprocessor *ast_threadpool_serializer_get_current(void);
  * \param pool \ref ast_threadpool for execution.
  *
  * \return \ref ast_taskprocessor for enqueuing work.
- * \return \c NULL on error.
+ * \retval NULL on error.
  */
 struct ast_taskprocessor *ast_threadpool_serializer(const char *name, struct ast_threadpool *pool);
 
@@ -288,7 +288,7 @@ struct ast_taskprocessor *ast_threadpool_serializer(const char *name, struct ast
  * \param shutdown_group Group shutdown controller. (NULL if no group association)
  *
  * \return \ref ast_taskprocessor for enqueuing work.
- * \return \c NULL on error.
+ * \retval NULL on error.
  */
 struct ast_taskprocessor *ast_threadpool_serializer_group(const char *name,
 	struct ast_threadpool *pool, struct ast_serializer_shutdown_group *shutdown_group);