[Asterisk-code-review] tests: Fix for Doxygen. (asterisk[16])

[George Joseph]

George Joseph has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/17386 )

Change subject: tests: Fix for Doxygen.
......................................................................

tests: Fix for Doxygen.

ASTERISK-29741

Change-Id: I012d72b237bda2ef2d0f86307dfc6dc7add4b54b
---
M tests/test_devicestate.c
M tests/test_dns_naptr.c
M tests/test_message.c
M tests/test_voicemail_api.c
4 files changed, 11 insertions(+), 11 deletions(-)

Approvals:
  Kevin Harwell: Looks good to me, but someone else must approve
  George Joseph: Looks good to me, approved; Approved for Submit



diff --git a/tests/test_devicestate.c b/tests/test_devicestate.c
index afefeb0..7166bf3 100644
--- a/tests/test_devicestate.c
+++ b/tests/test_devicestate.c
@@ -240,7 +240,7 @@
 /*! \brief The current device state for our device state provider */
 static enum ast_device_state current_device_state;
 
-/*! \brief Clear out all recorded device states in \ref result_states */
+/*! \brief Clear out all recorded device states in \p result_states */
 static void clear_result_states(void)
 {
 	ast_mutex_lock(&update_lock);
diff --git a/tests/test_dns_naptr.c b/tests/test_dns_naptr.c
index dc9e908..de6073f 100644
--- a/tests/test_dns_naptr.c
+++ b/tests/test_dns_naptr.c
@@ -51,7 +51,7 @@
  * the data ourselves and have sized the buffer to be way larger
  * than necessary for the tests.
  *
- * \param string The NAPTR record to encode
+ * \param dns_record The NAPTR record to encode
  * \param buf The buffer to write the record into
  * \return The number of bytes written to the buffer
  */
diff --git a/tests/test_message.c b/tests/test_message.c
index 1d03d74..dff6bd3 100644
--- a/tests/test_message.c
+++ b/tests/test_message.c
@@ -55,7 +55,7 @@
 /*! \brief The number of user events we expect for this test */
 static int expected_user_events;
 
-/*! \brief Predicate for the \ref test_message_handler receiving a message */
+/*! \brief Predicate for the \ref test_msg_handler receiving a message */
 static int handler_received_message;
 
 /*! \brief Condition wait variable for all dialplan user events being received */
diff --git a/tests/test_voicemail_api.c b/tests/test_voicemail_api.c
index 2338e38..c0dea58 100644
--- a/tests/test_voicemail_api.c
+++ b/tests/test_voicemail_api.c
@@ -283,9 +283,9 @@
 	} } while (0)
 
 /*!
- * \internal                                                                                                              .
- * \brief Playback a message on a channel or callback function                                                            .
- *                                                                                                                        .
+ * \internal
+ * \brief Playback a message on a channel or callback function
+ *
  * \note The channel name must be test_channel.
  * \note Fail the test if the message could not be played.
  */
@@ -411,7 +411,7 @@
  * \internal
  * \brief Make a voicemail mailbox folder based on the values provided in a message snapshot
  *
- * \param snapshot The snapshot containing the information to create the folder from
+ * \param folder_path The snapshot containing the information to create the folder from
  *
  * \returns 0 on success
  * \returns 1 on failure
@@ -615,10 +615,10 @@
  * This creates 4 voicemails, stores them on the file system, and creates snapshot objects
  * representing them for expected/actual value comparisons in the array test_snapshots.
  *
- * test_snapshots[0] => in test_vm_1234 at default, folder INBOX, message 0
- * test_snapshots[1] => in test_vm_1234 at default, folder Old, message 0
- * test_snapshots[2] => in test_vm_2345 at default, folder INBOX, message 0
- * test_snapshots[3] => in test_vm_2345 at default, folder Old, message 1
+ * test_snapshots[0] => in test_vm_1234\@default, folder INBOX, message 0
+ * test_snapshots[1] => in test_vm_1234\@default, folder Old, message 0
+ * test_snapshots[2] => in test_vm_2345\@default, folder INBOX, message 0
+ * test_snapshots[3] => in test_vm_2345\@default, folder Old, message 1
  *
  * \returns 0 on success
  * \returns 1 on failure

-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/17386
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 16
Gerrit-Change-Id: I012d72b237bda2ef2d0f86307dfc6dc7add4b54b
Gerrit-Change-Number: 17386
Gerrit-PatchSet: 2
Gerrit-Owner: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20211118/a8c62f19/attachment-0001.html>