diff options
author | Matt Jordan <mjordan@digium.com> | 2015-05-17 07:15:15 -0500 |
---|---|---|
committer | Matt Jordan <mjordan@digium.com> | 2015-05-19 21:11:21 -0500 |
commit | d8698b7f3f8a70f7e50ac7323b8236e7658a97f4 (patch) | |
tree | 1915ae5602bd9734f56c35f2c1902cc23c95b9e1 | |
parent | 908c6a51d69c84f790633e64d72a2f09037bd6cd (diff) |
doxygen: Fix doxygen errors
This patch fixes a number of errors and warning messages in the doxygen
log. Specifically, it addresses:
* A number of files incorrectly places a '\brief' tag immediately after
a '\file' tag. Doing so emits a warning, as '\file' takes an optional
argument specifying which file the doxygen comment is for. As '\brief'
is not a file, doxygen was unamused.
* A grouping of Stasis Topics and Messages in rtp_engine.h was
incorrectly terminated. We now correctly terminate the grouping, which
prevents members of rtp_engine.h from showing up in the wrong group.
* Group indicators which are not part of the Stasis Topics and Messages
group were removed. Group indicators without an \addtogroup or
\ingroup have no meaning.
Change-Id: Ia1415ffec6767e27233ae1cae5ed5970de5656d4
-rw-r--r-- | include/asterisk/event.h | 2 | ||||
-rw-r--r-- | include/asterisk/rtp_engine.h | 2 | ||||
-rw-r--r-- | include/asterisk/sem.h | 4 | ||||
-rw-r--r-- | include/asterisk/stasis.h | 34 | ||||
-rw-r--r-- | include/asterisk/stasis_test.h | 3 | ||||
-rw-r--r-- | main/sdp_srtp.c | 2 | ||||
-rw-r--r-- | res/res_stasis_test.c | 3 | ||||
-rw-r--r-- | tests/test_ari.c | 3 | ||||
-rw-r--r-- | tests/test_endpoints.c | 3 | ||||
-rw-r--r-- | tests/test_json.c | 3 | ||||
-rw-r--r-- | tests/test_optional_api.c | 3 | ||||
-rw-r--r-- | tests/test_res_stasis.c | 3 | ||||
-rw-r--r-- | tests/test_stasis.c | 3 | ||||
-rw-r--r-- | tests/test_stasis_channels.c | 3 | ||||
-rw-r--r-- | tests/test_stasis_endpoints.c | 3 | ||||
-rw-r--r-- | utils/extconf.c | 2 |
16 files changed, 32 insertions, 44 deletions
diff --git a/include/asterisk/event.h b/include/asterisk/event.h index 7eea0581d..dbc080da8 100644 --- a/include/asterisk/event.h +++ b/include/asterisk/event.h @@ -35,7 +35,7 @@ * modules in Asterisk. * - CEL uses the \ref ast_event representation to pass information to registered * backends. - * - The \file res_corosync module publishes \ref ast_event representations of + * - The \file res_corosync.c module publishes \ref ast_event representations of * information to other Asterisk instances in a cluster. * - Security event represent their event types and data using this system. * - Theoretically, any \ref stasis message can use this system to pass diff --git a/include/asterisk/rtp_engine.h b/include/asterisk/rtp_engine.h index a94cb4213..c7f6511f9 100644 --- a/include/asterisk/rtp_engine.h +++ b/include/asterisk/rtp_engine.h @@ -2316,7 +2316,7 @@ struct stasis_message_type *ast_rtp_rtcp_received_type(void); */ struct stasis_topic *ast_rtp_topic(void); -/* }@ */ +/* @} */ #if defined(__cplusplus) || defined(c_plusplus) } diff --git a/include/asterisk/sem.h b/include/asterisk/sem.h index 6d655d63e..fcab82a5e 100644 --- a/include/asterisk/sem.h +++ b/include/asterisk/sem.h @@ -20,7 +20,9 @@ #define ASTERISK_SEMAPHORE_H /*! - * \file Asterisk semaphore API + * \file + * + * \brief Asterisk semaphore API * * This API is a thin wrapper around the POSIX semaphore API (when available), * so see the POSIX documentation for further details. diff --git a/include/asterisk/stasis.h b/include/asterisk/stasis.h index 0b1b1e83f..aa681e13e 100644 --- a/include/asterisk/stasis.h +++ b/include/asterisk/stasis.h @@ -173,8 +173,6 @@ #include "asterisk/utils.h" #include "asterisk/event.h" -/*! @{ */ - /*! * \brief Metadata about a \ref stasis_message. * \since 12 @@ -451,10 +449,6 @@ struct ast_manager_event_blob *stasis_message_to_ami( struct ast_event *stasis_message_to_event( struct stasis_message *message); -/*! @} */ - -/*! @{ */ - /*! * \brief A topic to which messages may be posted, and subscribers, well, subscribe * \since 12 @@ -508,10 +502,6 @@ void stasis_publish(struct stasis_topic *topic, struct stasis_message *message); */ void stasis_publish_sync(struct stasis_subscription *sub, struct stasis_message *message); -/*! @} */ - -/*! @{ */ - /*! * \brief Callback function type for Stasis subscriptions. * \param data Data field provided with subscription. @@ -699,8 +689,6 @@ struct stasis_message_type *stasis_subscription_change_type(void); /*! @} */ -/*! @{ */ - /*! * \brief Pool for topic aggregation */ @@ -723,8 +711,6 @@ struct stasis_topic_pool *stasis_topic_pool_create(struct stasis_topic *pooled_t */ struct stasis_topic *stasis_topic_pool_get_topic(struct stasis_topic_pool *pool, const char *topic_name); -/*! @} */ - /*! \addtogroup StasisTopicsAndMessages * @{ */ @@ -757,8 +743,6 @@ struct stasis_message_type *stasis_cache_clear_type(void); /*! @} */ -/*! @{ */ - /*! * \brief A message cache, for use with \ref stasis_caching_topic. * \since 12 @@ -1090,6 +1074,10 @@ struct ao2_container *stasis_cache_dump_by_eid(struct stasis_cache *cache, struc */ struct ao2_container *stasis_cache_dump_all(struct stasis_cache *cache, struct stasis_message_type *type); +/*! \addtogroup StasisTopicsAndMessages + * @{ + */ + /*! * \brief Object type code for multi user object snapshots */ @@ -1163,8 +1151,6 @@ void ast_multi_object_blob_single_channel_publish(struct ast_channel *chan, stru /*! @} */ -/*! @{ */ - /*! * \internal * \brief Log a message about invalid attempt to access a type. @@ -1267,10 +1253,6 @@ void stasis_log_bad_type_access(const char *name); _priv_ ## name = NULL; \ }) -/*! @} */ - -/*! @{ */ - /*! * \brief Initialize the Stasis subsystem. * \return 0 on success. @@ -1279,10 +1261,6 @@ void stasis_log_bad_type_access(const char *name); */ int stasis_init(void); -/*! @} */ - -/*! @{ */ - /*! * \internal * \brief called by stasis_init() for cache initialization. @@ -1301,12 +1279,10 @@ int stasis_cache_init(void); */ int stasis_config_init(void); -/*! @} */ - /*! * \defgroup StasisTopicsAndMessages Stasis topics, and their messages. * - * This group contains the topics, messages and corresponding message types + * \brief This group contains the topics, messages and corresponding message types * found within Asterisk. */ diff --git a/include/asterisk/stasis_test.h b/include/asterisk/stasis_test.h index ad4020a08..d9df1c97f 100644 --- a/include/asterisk/stasis_test.h +++ b/include/asterisk/stasis_test.h @@ -20,7 +20,8 @@ #define _ASTERISK_STASIS_TEST_H /*! - * \file \brief Test infrastructure for dealing with Stasis. + * \file + * \brief Test infrastructure for dealing with Stasis. * * \author David M. Lee, II <dlee@digium.com> * diff --git a/main/sdp_srtp.c b/main/sdp_srtp.c index 8c86f1407..4ec9f810e 100644 --- a/main/sdp_srtp.c +++ b/main/sdp_srtp.c @@ -16,7 +16,7 @@ * at the top of the source tree. */ -/*! \file ast_sdp_crypto.c +/*! \file * * \brief SRTP and SDP Security descriptions * diff --git a/res/res_stasis_test.c b/res/res_stasis_test.c index 9164293f5..efdbc4b52 100644 --- a/res/res_stasis_test.c +++ b/res/res_stasis_test.c @@ -17,7 +17,8 @@ */ /*! - * \file \brief Test infrastructure for dealing with Stasis. + * \file + * \brief Test infrastructure for dealing with Stasis. * * \author David M. Lee, II <dlee@digium.com> */ diff --git a/tests/test_ari.c b/tests/test_ari.c index 55f44321a..efec810e1 100644 --- a/tests/test_ari.c +++ b/tests/test_ari.c @@ -17,7 +17,8 @@ */ /*! - * \file \brief Test ARI API. + * \file + * \brief Test ARI API. * \author\verbatim David M. Lee, II <dlee@digium.com> \endverbatim * * \ingroup tests diff --git a/tests/test_endpoints.c b/tests/test_endpoints.c index d90cd3a05..d1239037b 100644 --- a/tests/test_endpoints.c +++ b/tests/test_endpoints.c @@ -17,7 +17,8 @@ */ /*! - * \file \brief Test endpoints. + * \file + * \brief Test endpoints. * * \author\verbatim David M. Lee, II <dlee@digium.com> \endverbatim * diff --git a/tests/test_json.c b/tests/test_json.c index 7080face2..915578128 100644 --- a/tests/test_json.c +++ b/tests/test_json.c @@ -17,7 +17,8 @@ */ /*! - * \file \brief Test JSON API. + * \file + * \brief Test JSON API. * * While some of these tests are actually testing our JSON library wrapper, the bulk of * them are exploratory tests to determine what the behavior of the underlying JSON diff --git a/tests/test_optional_api.c b/tests/test_optional_api.c index a89b46159..f7809d32b 100644 --- a/tests/test_optional_api.c +++ b/tests/test_optional_api.c @@ -17,7 +17,8 @@ */ /*! - * \file \brief Test optional API. + * \file + * \brief Test optional API. * * This tests exercise the underlying implementation functions. Acutal usage * won't look anything like this; it would use the wrapper macros. diff --git a/tests/test_res_stasis.c b/tests/test_res_stasis.c index 7edc985e8..4e28d44c6 100644 --- a/tests/test_res_stasis.c +++ b/tests/test_res_stasis.c @@ -17,7 +17,8 @@ */ /*! - * \file \brief Test Stasis Application API. + * \file + * \brief Test Stasis Application API. * \author\verbatim David M. Lee, II <dlee@digium.com> \endverbatim * * \ingroup tests diff --git a/tests/test_stasis.c b/tests/test_stasis.c index 7061b97b6..b5755c843 100644 --- a/tests/test_stasis.c +++ b/tests/test_stasis.c @@ -17,7 +17,8 @@ */ /*! - * \file \brief Test Stasis message bus. + * \file + * \brief Test Stasis message bus. * * \author\verbatim David M. Lee, II <dlee@digium.com> \endverbatim * diff --git a/tests/test_stasis_channels.c b/tests/test_stasis_channels.c index f9bbb9621..fe320f29b 100644 --- a/tests/test_stasis_channels.c +++ b/tests/test_stasis_channels.c @@ -17,7 +17,8 @@ */ /*! - * \file \brief Test Stasis Channel messages and objects + * \file + * \brief Test Stasis Channel messages and objects * * \author\verbatim Matt Jordan <mjordan@digium.com> \endverbatim * diff --git a/tests/test_stasis_endpoints.c b/tests/test_stasis_endpoints.c index 8e3907ffe..848d86b1c 100644 --- a/tests/test_stasis_endpoints.c +++ b/tests/test_stasis_endpoints.c @@ -17,7 +17,8 @@ */ /*! - * \file \brief Test endpoints. + * \file + * \brief Test endpoints. * * \author\verbatim David M. Lee, II <dlee@digium.com> \endverbatim * diff --git a/utils/extconf.c b/utils/extconf.c index baca11bf5..4eaea3c2d 100644 --- a/utils/extconf.c +++ b/utils/extconf.c @@ -18,7 +18,7 @@ /*! - * \file extconf + * \file * A condensation of the pbx_config stuff, to read into exensions.conf, and provide an interface to the data there, * for operations outside of asterisk. A huge, awful hack. * |