<p> Attention is currently required from: George Joseph, Josh Soref. </p>
<p><a href="https://gerrit.asterisk.org/c/asterisk/+/17511">View Change</a></p><p>6 comments:</p><ul style="list-style: none; padding: 0;"><li style="margin: 0; padding: 0;"><p><a href="null">File include/asterisk/http_websocket.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/+/17511/comment/879cc301_459511f4">Patch Set #4, Line 224:</a> <code style="font-family:monospace,monospace"> * \param server Name of the sub-protocol to unregister</code></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">Same comment as before (sorry, should have commented on all of them)</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">Done</p></li><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.asterisk.org/c/asterisk/+/17511/comment/f9c33c1c_818a5c44">Patch Set #4, Line 258:</a> <code style="font-family:monospace,monospace"> * \return number of bytes read on success</code></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">General question: is there a convention to have a blank line between `\param` and one of `\retval` o […]</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">That is a style related question. I am not aware of a style guide for Doxygen from the Asterisk Team. So no, the fields (and blanks) can be placed everywhere, even their order, even the order of the parameter do not matter for Doxygen.</p><p style="white-space: pre-wrap; word-wrap: break-word;">Sometimes, I added a blank line. The goal of the overall change was primarily syntactic, I fixed warnings emitted by Doxygen. The second goal was to fix *obvious* semantic issues which Doxygen cannot detect, like this one because retval has one parameter/argument; and number does not make sense as that, therefore return. The third goal was to add a bit of consistency in the style.</p><p style="white-space: pre-wrap; word-wrap: break-word;">Perhaps this series of changes lead to a style guide, for new code. I am not so sure about existing code because the primary goal of Doxygen code should not be looking good in code but creating usable HTML/PDF documentation.</p></li></ul></li><li style="margin: 0; padding: 0;"><p><a href="null">File include/asterisk/http_websocket.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/+/17511/comment/dd97ff40_ff17b0c4">Patch Set #1, Line 132:</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;"> * \return New \ref ast_websocket_server instance<br> * \retval NULL on error<br></pre></blockquote></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">Shouldn't this just be […]</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">Done</p></li></ul></li><li style="margin: 0; padding: 0;"><p><a href="null">File include/asterisk/res_mwi_external.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/+/17511/comment/00081678_121d28b7">Patch Set #1, Line 93:</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;"> * \return copy on success.  The object is an ao2 object.<br> * \retval NULL on error.<br> */<br></pre></blockquote></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">Same as above?</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">Done</p></li><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.asterisk.org/c/asterisk/+/17511/comment/fd0d6abb_d96accc8">Patch Set #1, Line 166:</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;">* \return requested mailbox on success.  The object is an ao2 object.<br> * \retval NULL on error or no mailbox.<br> *<br></pre></blockquote></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">Same</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">Done</p></li><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.asterisk.org/c/asterisk/+/17511/comment/27a5c9be_f20ebfa0">Patch Set #1, Line 181:</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;"> * \return container of struct ast_mwi_mailbox_object on success.<br> * \retval NULL on error.<br></pre></blockquote></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">Same</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">Done</p></li></ul></li></ul><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/17511">change 17511</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/+/17511"/><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: I572e6019c422780dde5ce8448b6c85c77af6046d </div>
<div style="display:none"> Gerrit-Change-Number: 17511 </div>
<div style="display:none"> Gerrit-PatchSet: 4 </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: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-CC: Josh Soref <jsoref@gmail.com> </div>
<div style="display:none"> Gerrit-Attention: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-Attention: Josh Soref <jsoref@gmail.com> </div>
<div style="display:none"> Gerrit-Comment-Date: Thu, 25 Nov 2021 08:53:09 +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: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Comment-In-Reply-To: Josh Soref <jsoref@gmail.com> </div>
<div style="display:none"> Gerrit-MessageType: comment </div>