[Asterisk-code-review] general: Very minor formatting improvements. (asterisk[master])

[Richard Mudgett]

Attention is currently required from: N A.
Richard Mudgett has posted comments on this change. ( https://gerrit.asterisk.org/c/asterisk/+/18885 )

Change subject: general: Very minor formatting improvements.
......................................................................


Patch Set 2:

(1 comment)

File channels/iax2/include/iax2.h:

https://gerrit.asterisk.org/c/asterisk/+/18885/comment/9a45c545_365f1ddd 
PS2, Line 131: #define IAX_IE_CALLED_NUMBER			1		/*!< Number/extension being called - string */
> Okay, I see what you're seeing now, I think, which is definitely kind off. […]
Tabs after the first non-whitespace will ALWAYS be an issue because of the disagreement of how to expand tabs in different environments.  But this is the Asterisk coding format.  It is better to have comments above the item being described rather than having end-of-line comments that need to line up to look good.  Putting the comments above avoids most of the issues with tabs in code presentation.  A bonus of commenting above the item is you have more room for the comment before hitting the 90 column limit.

/*! Calling number - string */
#define IAX_IE_CALLING_NUMBER    2

struct foo {
    /*! This member does blah */
    int member;
    /*! This member does something else that is needed */
    int bar;
};

/*!
 * \brief Do this foo thing
 *
 * \param bar How much to do something with foo.
 *
 * \retvar -1 on error is not always true.  People have a tendency to assume this.
 */
int foo(int bar)
{
    /*! To do foo's things */
    int another_foo;
    /*! Index into some foo array */
    int idx;

    return -1;
}



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

Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Change-Id: I07771c4c89facd41ce8d323859f022ddbddf6ca7
Gerrit-Change-Number: 18885
Gerrit-PatchSet: 2
Gerrit-Owner: N A <mail at interlinked.x10host.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: Richard Mudgett <rmudgett at digium.com>
Gerrit-Attention: N A <mail at interlinked.x10host.com>
Gerrit-Comment-Date: Wed, 03 Aug 2022 12:59:22 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Comment-In-Reply-To: N A <mail at interlinked.x10host.com>
Comment-In-Reply-To: Richard Mudgett <rmudgett at digium.com>
Gerrit-MessageType: comment
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220803/3e86ebac/attachment.html>