<p> Attention is currently required from: Kevin Harwell. </p>
<p><a href="https://gerrit.asterisk.org/c/asterisk/+/17587">View Change</a></p><p>4 comments:</p><ul style="list-style: none; padding: 0;"><li style="margin: 0; padding: 0;"><p><a href="null">File include/asterisk/test.h:</a></p><ul style="list-style: none; padding: 0;"><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.asterisk.org/c/asterisk/+/17587/comment/c1ef6927_cb557fee">Patch Set #1, Line 179:</a> </p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;"><pre style="font-family: monospace,monospace; white-space: pre-wrap;"> * \param s The state the application has changed to<br> * \param f The message with format parameters to add to the manager event<br> */<br>#define ast_test_suite_event_notify(s, f, ...) \<br>     __ast_test_suite_event_notify(__FILE__, __PRETTY_FUNCTION__, __LINE__, (s), (f), ## __VA_ARGS__)<br></pre></blockquote></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">I assume the '... […]</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">Yes, no warning.</p><p style="white-space: pre-wrap; word-wrap: break-word;">I figured that out quite late, Doxygen does not require a documentation for variable parameters, therefore no warning. I (tried) to keep the way I found, sometimes it makes sense to describe that there are variable arguments. However, as I explained to George when it comes to the return/retval, this is somehow a local ‘Asterisk Doxygen Style Guide’ topic: Should there be a documentation for variable parameters always, never, or in case? Cannot decide on that. So I kept what I found, when it added something.</p></li><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.asterisk.org/c/asterisk/+/17587/comment/490181c7_65db0a0a">Patch Set #1, Line 362:</a> </p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;"><pre style="font-family: monospace,monospace; white-space: pre-wrap;"> * \param t currently executing test<br> * \param f printf type format string<br> *<br> * \retval 0 success<br> * \retval -1 failure<br> */<br>#define ast_test_status_update(t, f, ...) __ast_test_status_update(__FILE__, __PRETTY_FUNCTION__, __LINE__, (t), (f), ## __VA_ARGS__)<br></pre></blockquote></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">No need for '... […]</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">Same as before.</p></li></ul></li><li style="margin: 0; padding: 0;"><p><a href="null">File main/dns_test.c:</a></p><ul style="list-style: none; padding: 0;"><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.asterisk.org/c/asterisk/+/17587/comment/a4b14d81_68b24ff4">Patch Set #1, Line 148:</a> </p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;"><pre style="font-family: monospace,monospace; white-space: pre-wrap;">/*!<br> * \brief Write a DNS string to a buffer<br> *<br> * This writes the DNS string to the buffer and returns the total<br> * number of bytes written to the buffer.<br> *<br> * There is no buffer size passed to this function since we provide<br> * the data ourselves and have sized the buffer to be way larger<br> * than necessary for the tests.<br> *<br> * \param string The string to write<br> * \param buf The buffer to write the string into<br> * \return The number of bytes written to the buffer<br> */<br></pre></blockquote></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">Why is this block removed?</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">It is a duplicate to the Doxygen in include/asterisk/dns_test.h.</p><p style="white-space: pre-wrap; word-wrap: break-word;">Doxygen is a bit picky when it finds multiple parameter (or return) documentation. Even with the same wording, Doxygen emits a warning. Because it is a duplicate, I removed it in the source file and kept the version of the header file. I could have left a ‘brief’. I think Doxygen has no problems with a ‘details’ too. It is just parameter and return/retval. Anyway, I opted to remove it completely because redundant. If you like it otherwise, please, say so.</p></li><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.asterisk.org/c/asterisk/+/17587/comment/b62eff90_ed7a5def">Patch Set #1, Line 178:</a> </p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;"><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><br>/*!<br> * \brief Write a DNS domain to a buffer<br> *<br> * A DNS domain consists of a series of labels separated<br> * by dots. Each of these labels gets written as a DNS<br> * string. A DNS domain ends with a NULL label, which is<br> * essentially a zero-length DNS string.<br> *<br> *<br> * There is no buffer size passed to this function since we provide<br> * the data ourselves and have sized the buffer to be way larger<br> * than necessary for the tests.<br> *<br> * \param string The DNS domain to write<br> * \param buf The buffer to write the domain into<br> * \return The number of bytes written to the buffer<br> */<br></pre></blockquote></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">Same, why remove this one?</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">Same as with ast_dns_test_write_string, it is a redundant duplicate of what is written in the header file dns_test.</p></li></ul></li></ul><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/17587">change 17587</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/17587"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: If338163488498f65fa7248b60e80299c0a928e4b </div>
<div style="display:none"> Gerrit-Change-Number: 17587 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Alexander Traud <pabstraud@compuserve.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-CC: Kevin Harwell <kharwell@digium.com> </div>
<div style="display:none"> Gerrit-Attention: Kevin Harwell <kharwell@digium.com> </div>
<div style="display:none"> Gerrit-Comment-Date: Wed, 01 Dec 2021 09:19:57 +0000 </div>
<div style="display:none"> Gerrit-HasComments: Yes </div>
<div style="display:none"> Gerrit-Has-Labels: No </div>
<div style="display:none"> Comment-In-Reply-To: Kevin Harwell <kharwell@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: comment </div>