[Asterisk-code-review] main: Fix for Doxygen. (asterisk[master])

[Alexander Traud]

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

Change subject: main: Fix for Doxygen.
......................................................................


Patch Set 3:

(2 comments)

File include/asterisk/fskmodem_int.h:

https://gerrit.asterisk.org/c/asterisk/+/17514/comment/480e732f_07faf921 
PS3, Line 69: /* \brief Retrieve a serial byte into outbyte.
            :    Buffer is a pointer into a series of
            :    shorts and len records the number of bytes in the buffer.  len will be
            :    overwritten with the number of bytes left that were not consumed.
            :    \return return value is as follows:
            :    \arg 0: Still looking for something...
            :    \arg 1: An output byte was received and stored in outbyte
            :    \arg -1: An error occured in the transmission
            :    This must be called with at least 80 bytes of buffer. */
> Why was this documentation removed?
It gave a warning because of multiple definitions of return values. The problem is that Doxygen somehow collects the symbols and overloads the one from fskmodem_float. I had two alternatives:
(a) live with the hard to understand warning or
(b) remove the description in one _float or _int.


File main/media_cache.c:

https://gerrit.asterisk.org/c/asterisk/+/17514/comment/1ae1ccac_6f47ce73 
PS3, Line 131:  * \param bucket_file The \ref ast_bucket_file media cache item to upadte
> Surprised this didn't give a warning. This parameter/line should be swapped with the one above. […]
Doxygen does not care about the order of the parameters while describing them. Anyway, I am going to swap it (and fix the typing error in ‘update’).



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

Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Change-Id: Ib8359e3590a9109eb04a5376559d040e5e21867e
Gerrit-Change-Number: 17514
Gerrit-PatchSet: 3
Gerrit-Owner: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-Attention: Kevin Harwell <kharwell at digium.com>
Gerrit-Comment-Date: Wed, 24 Nov 2021 18:59:31 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Comment-In-Reply-To: Kevin Harwell <kharwell at digium.com>
Gerrit-MessageType: comment
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20211124/71fe0e77/attachment-0001.html>