]> git.pond.sub.org Git - empserver/commit
Change comment style to use @foo rather than FOO
authorMarkus Armbruster <armbru@pond.sub.org>
Sun, 14 Jun 2015 08:33:43 +0000 (10:33 +0200)
committerMarkus Armbruster <armbru@pond.sub.org>
Sat, 5 Dec 2015 11:13:17 +0000 (12:13 +0100)
commit9f25de3dce4ec1326337b6ce2f6a68046a014e65
treeaebefabadb6925769aebae297652f378aa36bade
parent5cff5022a9e1fe5257bf4758bafdedeb7e3f68a4
Change comment style to use @foo rather than FOO

... 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>
77 files changed:
include/empthread.h
include/map.h
include/misc.h
include/nsc.h
src/client/linebuf.c
src/client/play.c
src/client/ringbuf.c
src/client/secure.c
src/lib/commands/flash.c
src/lib/commands/laun.c
src/lib/commands/rea.c
src/lib/commands/xdump.c
src/lib/common/btu.c
src/lib/common/cargo.c
src/lib/common/cnumb.c
src/lib/common/conftab.c
src/lib/common/ef_verify.c
src/lib/common/file.c
src/lib/common/game.c
src/lib/common/hours.c
src/lib/common/mailbox.c
src/lib/common/nat.c
src/lib/common/nstreval.c
src/lib/common/pathfind.c
src/lib/common/rdsched.c
src/lib/common/stmtch.c
src/lib/common/type.c
src/lib/common/xdump.c
src/lib/common/xundump.c
src/lib/common/xy.c
src/lib/empthread/io.c
src/lib/gen/chance.c
src/lib/gen/fnameat.c
src/lib/gen/fsize.c
src/lib/gen/log.c
src/lib/gen/parse.c
src/lib/lwp/sel.c
src/lib/lwp/sig.c
src/lib/player/accept.c
src/lib/player/dispatch.c
src/lib/player/empdis.c
src/lib/player/player.c
src/lib/player/recvclient.c
src/lib/subs/actofgod.c
src/lib/subs/attsub.c
src/lib/subs/bridgefall.c
src/lib/subs/coastal.c
src/lib/subs/control.c
src/lib/subs/fortdef.c
src/lib/subs/getele.c
src/lib/subs/getstarg.c
src/lib/subs/getstring.c
src/lib/subs/landgun.c
src/lib/subs/lndsub.c
src/lib/subs/lostsub.c
src/lib/subs/maps.c
src/lib/subs/mission.c
src/lib/subs/mtch.c
src/lib/subs/natarg.c
src/lib/subs/nstr.c
src/lib/subs/paths.c
src/lib/subs/plnsub.c
src/lib/subs/pr.c
src/lib/subs/radmap.c
src/lib/subs/show.c
src/lib/subs/shpsub.c
src/lib/subs/snxtitem.c
src/lib/subs/trdsub.c
src/lib/subs/unitsub.c
src/lib/subs/whatitem.c
src/lib/subs/wu.c
src/lib/update/bp.c
src/lib/update/human.c
src/lib/update/material.c
src/lib/update/produce.c
src/lib/update/sect.c
src/server/shutdown.c