RepoMirrors
/
ffmpeg
mirror of https://git.ffmpeg.org/ffmpeg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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
This commit is contained in:
Stefano Sabatini 2010-07-04 15:40:03 +00:00
parent 07a90cd5bf
commit f2c44ad511
1 changed files with 0 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/developer.texi
View 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