[Asterisk-code-review] progdocs: Fix for Doxygen, the hidden parts. (asterisk[master])

[Kevin Harwell]

Attention is currently required from: Alexander Traud.
Kevin Harwell has posted comments on this change. ( https://gerrit.asterisk.org/c/asterisk/+/17587 )

Change subject: progdocs: Fix for Doxygen, the hidden parts.
......................................................................


Patch Set 1:

(4 comments)

File include/asterisk/test.h:

https://gerrit.asterisk.org/c/asterisk/+/17587/comment/bd5d0083_b4f02754 
PS1, Line 179:  * \param s The state the application has changed to
             :  * \param f The message with format parameters to add to the manager event
             :  */
             : #define ast_test_suite_event_notify(s, f, ...) \
             : 	__ast_test_suite_event_notify(__FILE__, __PRETTY_FUNCTION__, __LINE__, (s), (f), ## __VA_ARGS__)
I assume the '...' param is ignored or optional in Doxygen? I noticed in another file you included it (albeit there you were replace current invalid params), but not here.


https://gerrit.asterisk.org/c/asterisk/+/17587/comment/97c7acae_1e2052ba 
PS1, Line 362:  * \param t currently executing test
             :  * \param f printf type format string
             :  *
             :  * \retval 0 success
             :  * \retval -1 failure
             :  */
             : #define ast_test_status_update(t, f, ...) __ast_test_status_update(__FILE__, __PRETTY_FUNCTION__, __LINE__, (t), (f), ## __VA_ARGS__)
No need for '...' here too?


File main/dns_test.c:

https://gerrit.asterisk.org/c/asterisk/+/17587/comment/e94f3611_f239a083 
PS1, Line 148: /*!
             :  * \brief Write a DNS string to a buffer
             :  *
             :  * This writes the DNS string to the buffer and returns the total
             :  * number of bytes written to the buffer.
             :  *
             :  * There is no buffer size passed to this function since we provide
             :  * the data ourselves and have sized the buffer to be way larger
             :  * than necessary for the tests.
             :  *
             :  * \param string The string to write
             :  * \param buf The buffer to write the string into
             :  * \return The number of bytes written to the buffer
             :  */
Why is this block removed?


https://gerrit.asterisk.org/c/asterisk/+/17587/comment/c938cbcb_6c9d1825 
PS1, Line 178: 
             : /*!
             :  * \brief Write a DNS domain to a buffer
             :  *
             :  * A DNS domain consists of a series of labels separated
             :  * by dots. Each of these labels gets written as a DNS
             :  * string. A DNS domain ends with a NULL label, which is
             :  * essentially a zero-length DNS string.
             :  *
             :  *
             :  * There is no buffer size passed to this function since we provide
             :  * the data ourselves and have sized the buffer to be way larger
             :  * than necessary for the tests.
             :  *
             :  * \param string The DNS domain to write
             :  * \param buf The buffer to write the domain into
             :  * \return The number of bytes written to the buffer
             :  */
Same, why remove this one?



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

Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Change-Id: If338163488498f65fa7248b60e80299c0a928e4b
Gerrit-Change-Number: 17587
Gerrit-PatchSet: 1
Gerrit-Owner: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-CC: Kevin Harwell <kharwell at digium.com>
Gerrit-Attention: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Comment-Date: Tue, 30 Nov 2021 17:50:59 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Gerrit-MessageType: comment
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20211130/b9bd37bb/attachment.html>