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

[Michael Niedermayer]

On Fri, Jul 09, 2010 at 12:57:49AM +0200, Stefano Sabatini wrote:
> 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?

patch on hold until corresponding vote is finished

[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

If you think the mosad wants you dead since a long time then you are either
wrong or dead since a long time.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20100709/faf52601/attachment.pgp>