State in the guidelines that function and parameter descriptions in
authorStefano Sabatini <stefano.sabatini-lala@poste.it>
Sat, 3 Jul 2010 18:19:38 +0000 (18:19 +0000)
committerStefano Sabatini <stefano.sabatini-lala@poste.it>
Sat, 3 Jul 2010 18:19:38 +0000 (18:19 +0000)
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

doc/developer.texi

index edce7ea..c816352 100644 (file)
@@ -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