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 /tests | |
| 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
Diffstat (limited to 'tests')
| -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 |
8 files changed, 16 insertions, 8 deletions
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 * |