empire/empserver
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Change comment style to use @foo rather than FOO

Browse source 
... when referring to a function's parameter or a struct/union's
member.

The idea of using FOO comes from the GNU coding standards:

    The comment on a function is much clearer if you use the argument
    names to speak about the argument values.  The variable name
    itself should be lower case, but write it in upper case when you
    are speaking about the value rather than the variable itself.
    Thus, "the inode number NODE_NUM" rather than "an inode".

Upcasing names is problematic for a case-sensitive language like C,
because it can create ambiguity.  Moreover, it's too much shouting for
my taste.

GTK-Doc's convention to prefix the identifier with @ makes references
to variables stand out nicely.  The rest of the GTK-Doc conventions
make no sense for us, however.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
This commit is contained in:
Markus Armbruster 2015-06-14 10:33:43 +02:00
parent 5cff5022a9
commit 9f25de3dce
77 changed files with 633 additions and 633 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/lib/common/stmtch.c
View file

@ -35,14 +35,14 @@
#include "match.h"
/*
* Find element named NEEDLE in array HAYSTACK[], return its index.
* Find element named @needle in array @haystack[], return its index.
* Return M_NOTFOUND if there are no matches, M_NOTUNIQUE if there are
* several.
* Each array element has a pointer to its name stored at offset OFFS.
* Each array element has a pointer to its name stored at offset @offs.
* Search stops when this name is a null pointer.
* It ignores elements with an empty name.
* NEEDLE is compared to element names with mineq(NEEDLE, NAME).
* SIZE gives the size of an array element.
* @needle is compared to element names with mineq(@needle, NAME).
* @size gives the size of an array element.
*/
int
stmtch(char *needle, void *haystack, ptrdiff_t offs, size_t size)
@ -74,10 +74,10 @@ stmtch(char *needle, void *haystack, ptrdiff_t offs, size_t size)
}
/*
* Compare A with B.
* Return ME_EXACT if they are the same, or A is a prefix of B
* followed by a space in B.
* Return ME_PARTIAL if A is a prefix of B not followed by a space.
* Compare @a with @b.
* Return ME_EXACT if they are the same, or @a is a prefix of @b
* followed by a space in @b.
* Return ME_PARTIAL if @a is a prefix of @b not followed by a space.
* Else return ME_MISMATCH.
*/
int