debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-22 02:48:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

STYLE: document rules for calls, block comments, ternary ops

Browse source
This commit is contained in:
David Bremner 2019-06-12 19:49:13 -03:00
parent 2c4384a576
commit 87df05d181
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
devel/STYLE
View file

@ -53,11 +53,19 @@ function (param_type param, param_type param)
if/for/while test) and are preceded by a space. The opening brace of
functions is the exception, and starts on a new line.
* Comments are always C-style /* */ block comments. They should start
with a capital letter and generally be written in complete
sentences. Public library functions are documented immediately
before their prototype in lib/notmuch.h. Internal functions are
typically documented immediately before their definition.
* Opening parens also cuddle, even if the first argument does not fit
on the same line.
* Ternary operators that span a line should be parenthesized like as
"a ? (\n b ) : c". This is mainly to keep the indentation tools
happy.
* Comments are always C-style /* */ block comments, with a leading *
each line. They should start with a capital letter and generally be
written in complete sentences. Public library functions are
documented immediately before their prototype in lib/notmuch.h.
Internal functions are typically documented immediately before their
definition.
* Code lines should be less than 80 columns and comments should be
wrapped at 70 columns.