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/mailbox.c
View file

@ -49,7 +49,7 @@ mailbox(char *buf, natid cn)
}
/*
* Create an empty telegram file named MBOX.
* Create an empty telegram file named @mbox.
* Return 0 on success, -1 on failure.
*/
int
@ -66,8 +66,8 @@ mailbox_create(char *mbox)
}
/*
* Read telegram header from FP into TEL.
* MBOX is the file name, it is used for logging errors.
* Read telegram header from @fp into @tel.
* @mbox is the file name, it is used for logging errors.
* Return 1 on success, 0 on EOF, -1 on error.
*/
int
@ -87,12 +87,12 @@ tel_read_header(FILE *fp, char *mbox, struct telstr *tel)
}
/*
* Read telegram body from FP.
* MBOX is the file name, it is used for logging errors.
* TEL is the header.
* Unless SINK is null, it is called like SINK(CHUNK, SZ, ARG) to
* Read telegram body from @fp.
* @mbox is the file name, it is used for logging errors.
* @tel is the header.
* Unless @sink is null, it is called like @sink(CHUNK, SZ, @arg) to
* consume the body, chunk by chunk. The chunks are UTF-8, and
* CHUNK[SZ} is 0. Reading fails when SINK() returns a negative
* CHUNK[SZ} is 0. Reading fails when @sink() returns a negative
* value.
* Return 0 on success, -1 on failure.
*/