diff options
| author | Stefano Sabatini <stefano.sabatini-lala@poste.it> | 2010-07-03 18:19:38 +0000 |
|---|---|---|
| committer | Stefano Sabatini <stefano.sabatini-lala@poste.it> | 2010-07-03 18:19:38 +0000 |
| commit | 0e7fa0bc3ba8eaea3eb623aa269806d2eca3a2c2 (patch) | |
| tree | 8c7fb68410411ee352b6f00508a5e736c26d12bb /doc | |
| parent | b7cdddcd1f0cbee60f6322ead7f13acd02fb55ca (diff) | |
State in the guidelines that function and parameter descriptions in
the doxy must use impersonal verbal form.
This form is apparently favored by most English speaker developers,
and has the advantage of being easier to use than the third person
form.
This should hopefully put an end to the Third Person Holy Bikeshed
War.
Originally committed as revision 24023 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer.texi | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index edce7ea63a..c8163529dc 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -83,6 +83,9 @@ format (see examples below) so that code documentation can be generated automatically. All nontrivial functions should have a comment above them explaining what the function does, even if it is just one sentence. All structures and their member variables should be documented, too. +Impersonal form must be used for the function and parameter +descriptions, e.g. "Set the bikeshed color." is favored over "Sets the +bikeshed color.". @example /** * @@file mpeg.c |