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

[Alexander Traud]

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

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


Patch Set 1:

(1 comment)

Patchset:

PS1: 
> I may have missed the "return and retval" situation in earlier reviews. […]
I described it one of the issue reports: The problem was that code existed which used ‘retval \c NULL’. That created a warning because the first word after retval is a parameter. And Doxygen got confused because \c is an environment. The solution was then to go for ‘retval NULL’ especially because NULL is then displayed as typewriter font. Then, for consistency, I changed all ‘return \c NULL’ to ‘retval NULL’. And then for consistency, I moved all fixed values into retval, like NULL.

Of course, you could follow/create a style guide to go for just a one-return-liner if just a single exception exists. Or no return at all. Or … Anyway, all the files I touched, I (tried!) to follow that style, recommended in the Doxygen ‘sphere’ as well <https://github.com/doxygen/doxygen/issues/7769#issuecomment-626348804>

My patches are (mainly!) about fixing all *syntax* errors, those for which Doxygen creates an actual warning. Sometimes, I apply file-wide *style* to get it a bit more consistent. Personally, I prefer that extra NULL because one the can grep/regex easier through the code, if he/she wants to create a certain style.

In other words, my changes do not follow an consistent style on the *semantic* level. I focused on *syntactic* level. If somebody wants to improve the semantics, welcome! But not my area right now.

Long story short, ‘retval \c NULL’ was the problem, I tried to fix somehow.



-- 
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: George Joseph <gjoseph at digium.com>
Gerrit-Comment-Date: Fri, 19 Nov 2021 16:10:46 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Comment-In-Reply-To: George Joseph <gjoseph at digium.com>
Gerrit-MessageType: comment
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20211119/b5a10d5c/attachment.html>