[FFmpeg-devel] [PATCH] SHA-256 support

Kostya kostya.shishkov
Wed Jun 10 18:37:54 CEST 2009


On Wed, Jun 10, 2009 at 05:17:20PM +0200, Diego Biurrun wrote:
> On Wed, Jun 10, 2009 at 06:11:49PM +0300, Kostya wrote:
> > 
> > --- libavutil/sha2.h	(revision 0)
> > +++ libavutil/sha2.h	(revision 0)
> > @@ -0,0 +1,55 @@
> > +/**
> > + * initialize SHA-224/256 hashing
> 
> Write proper sentences please.  Start them with capital letters and end
> them in periods.  Also, use third person singular.

Like this:
Initializes SHA-224/256 hashing.
Updates hash value.
Finishes hashing and output digest value.
?

Or like really proper sentences:
This function initializes ...

It looks for me that any documentation may be only in two states:
redundant or incomplete :(
 
> Diego



More information about the ffmpeg-devel mailing list