diff options
| author | Stefano Sabatini <stefano.sabatini-lala@poste.it> | 2010-07-04 15:40:03 +0000 |
|---|---|---|
| committer | Stefano Sabatini <stefano.sabatini-lala@poste.it> | 2010-07-04 15:40:03 +0000 |
| commit | f2c44ad51160da4c0c27429e874265c0dff3d117 (patch) | |
| tree | 96a74a6de0ac761b68ce2b4f7a140e7996453c2f /doc/developer.texi | |
| parent | 07a90cd5bf6ebb559bd22d833bdbf5edf577e4ee (diff) | |
Revert commit:
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
Diffstat (limited to 'doc/developer.texi')
| -rw-r--r-- | doc/developer.texi | 3 |
1 files changed, 0 insertions, 3 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index c8163529dc..edce7ea63a 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -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 |