[Asterisk-code-review] res: Fix of Doxygen. (asterisk[master])

[George Joseph]

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

Change subject: res: Fix of Doxygen.
......................................................................


Patch Set 1:

(5 comments)

Patchset:

PS1: 
I may have missed the "return and retval" situation in earlier reviews.  If I did, then consider this just a question about doxygen best practices and I'll change this review to +1.


File include/asterisk/http_websocket.h:

https://gerrit.asterisk.org/c/asterisk/+/17511/comment/79db62a1_61ca3fdb 
PS1, Line 132:  * \return New \ref ast_websocket_server instance
             :  * \retval NULL on error
Shouldn't this just be
"\return New \ref ast_websocket_server instance or NULL on error"
without the "\retval"?


File include/asterisk/res_mwi_external.h:

https://gerrit.asterisk.org/c/asterisk/+/17511/comment/914ba330_44e199cc 
PS1, Line 93:  * \return copy on success.  The object is an ao2 object.
            :  * \retval NULL on error.
            :  */
Same as above?


https://gerrit.asterisk.org/c/asterisk/+/17511/comment/ac8e211f_e44a4a8d 
PS1, Line 166: * \return requested mailbox on success.  The object is an ao2 object.
             :  * \retval NULL on error or no mailbox.
             :  *
Same


https://gerrit.asterisk.org/c/asterisk/+/17511/comment/c1074365_c5f6a5dc 
PS1, Line 181:  * \return container of struct ast_mwi_mailbox_object on success.
             :  * \retval NULL on error.
Same



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

Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Change-Id: I572e6019c422780dde5ce8448b6c85c77af6046d
Gerrit-Change-Number: 17511
Gerrit-PatchSet: 1
Gerrit-Owner: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-CC: George Joseph <gjoseph at digium.com>
Gerrit-Attention: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Comment-Date: Fri, 19 Nov 2021 14:40:56 +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/20211119/21c7d62c/attachment.html>