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

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

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