[FFmpeg-devel] [doxy-person-bikeshed PATCH] State in the guidelines that function and parameter descriptions in the doxy must use impersonal verbal form.

[Stefano Sabatini]

On date Sunday 2010-07-04 17:43:15 +0200, Stefano Sabatini encoded:
> This form is apparently favored by most English speaker developers,
> and has the advantage of being easier to use than the third person
> form.
> ---
>  doc/developer.texi |    3 +++
>  1 files changed, 3 insertions(+), 0 deletions(-)
> 
> diff --git a/doc/developer.texi b/doc/developer.texi
> index edce7ea..c816352 100644
> --- a/doc/developer.texi
> +++ b/doc/developer.texi
> @@ -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

So OK to apply?

Regards.
-- 
FFmpeg = Fabulous & Fucking Meaningful Pacific Embarassing Guru