mirror of
https://github.com/asterisk/asterisk.git
synced 2025-10-12 15:45:18 +00:00
stasis: Fix for Doxygen.
ASTERISK-29750 Change-Id: Iea50173e785b2e9d49bc24c0af7111cfd96d44a9
This commit is contained in:
committed by
Kevin Harwell
parent
173bc6b4c3
commit
acd1cd66b8
@@ -250,8 +250,8 @@
|
||||
* The destructors of both have assertions regarding this to catch ref-counting
|
||||
* problems where a subscription or topic has had an extra ao2_cleanup().
|
||||
*
|
||||
* The \ref dispatch object is a transient object, which is posted to a
|
||||
* subscription's taskprocessor to send a message to the subscriber. They have
|
||||
* The \ref dispatch_exec_sync object is a transient object, which is posted to
|
||||
* a subscription's taskprocessor to send a message to the subscriber. They have
|
||||
* short life cycles, allocated on one thread, destroyed on another.
|
||||
*
|
||||
* During shutdown, or the deletion of a domain object, there are a flurry of
|
||||
@@ -750,7 +750,6 @@ static void subscription_dtor(void *obj)
|
||||
/*!
|
||||
* \brief Invoke the subscription's callback.
|
||||
* \param sub Subscription to invoke.
|
||||
* \param topic Topic message was published to.
|
||||
* \param message Message to send.
|
||||
*/
|
||||
static void subscription_invoke(struct stasis_subscription *sub,
|
||||
|
@@ -752,7 +752,7 @@ struct ast_json *ast_bridge_snapshot_to_json(
|
||||
* \internal
|
||||
* \brief Allocate the fields of an \ref ast_bridge_channel_snapshot_pair.
|
||||
*
|
||||
* \param pair A bridge and channel to get snapshots of
|
||||
* \param channel, bridge A bridge and channel to get snapshots of
|
||||
* \param[out] snapshot_pair An allocated snapshot pair.
|
||||
* \retval 0 Success
|
||||
* \retval non-zero Failure
|
||||
|
@@ -390,7 +390,7 @@ struct stasis_message *stasis_cache_entry_get_remote(struct stasis_cache_entry *
|
||||
*
|
||||
* \note The entries container is already locked.
|
||||
*
|
||||
* \retval Cache-entry on success.
|
||||
* \return Cache-entry on success.
|
||||
* \retval NULL Not in cache.
|
||||
*/
|
||||
static struct stasis_cache_entry *cache_find(struct ao2_container *entries, struct stasis_message_type *type, const char *id)
|
||||
@@ -625,8 +625,8 @@ struct ao2_container *stasis_cache_get_all(struct stasis_cache *cache, struct st
|
||||
*
|
||||
* \note The returned snapshot has not had its reference bumped.
|
||||
*
|
||||
* \retval Snapshot from the cache.
|
||||
* \retval \c NULL if snapshot is not found.
|
||||
* \return Snapshot from the cache.
|
||||
* \retval NULL if snapshot is not found.
|
||||
*/
|
||||
static struct stasis_message *cache_entry_by_eid(const struct stasis_cache_entry *entry, const struct ast_eid *eid)
|
||||
{
|
||||
|
@@ -157,9 +157,10 @@ static void state_proxy_sub_cb(void *obj, void *data)
|
||||
* \param manager The owning manager
|
||||
* \param state_topic A state topic to be managed
|
||||
* \param id The unique id for the state
|
||||
* \param file, line, func
|
||||
*
|
||||
* \return A stasis_state object or NULL
|
||||
* \return NULL on error
|
||||
* \retval NULL on error
|
||||
*
|
||||
* \pre manager->states must be locked.
|
||||
* \pre manager->states does not contain an object matching key \a id.
|
||||
@@ -265,9 +266,9 @@ error_return:
|
||||
* \param id The unique id for the state (if NULL state_topic is required)
|
||||
*
|
||||
* \return The added state object
|
||||
* \return NULL on error
|
||||
* \retval NULL on error
|
||||
*/
|
||||
#define state_find_or_add(mgr, top, id) __state_find_or_add(mgr, top, id, __FILE__, __LINE__, __PRETTY_FUNCTION__)
|
||||
#define state_find_or_add(manager, state_topic, id) __state_find_or_add(manager, state_topic, id, __FILE__, __LINE__, __PRETTY_FUNCTION__)
|
||||
static struct stasis_state *__state_find_or_add(struct stasis_state_manager *manager,
|
||||
struct stasis_topic *state_topic, const char *id,
|
||||
const char *file, int line, const char *func)
|
||||
|
Reference in New Issue
Block a user