Revert commit:
authorStefano Sabatini <stefano.sabatini-lala@poste.it>
Sun, 4 Jul 2010 15:40:03 +0000 (15:40 +0000)
committerStefano Sabatini <stefano.sabatini-lala@poste.it>
Sun, 4 Jul 2010 15:40:03 +0000 (15:40 +0000)
  Author: stefano
  Date: Sat Jul  3 20:19:38 2010
  New Revision: 24023

  Log:
  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.

The change was neither discussed on the FFmpeg ML, nor approved by the
project leader.

The Holy War will continue soon on FFmpeg-devel, stay tuned ;-).

Originally committed as revision 24039 to svn://svn.ffmpeg.org/ffmpeg/trunk

doc/developer.texi

index c816352..edce7ea 100644 (file)
@@ -83,9 +83,6 @@ 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