[Ffmpeg-devel] [PATCH]Update Doxygen comments for libavutil/tree.h

[Dujardin Bernard]

Michael Niedermayer a ?crit :
> Hi
>
> On Mon, Feb 26, 2007 at 11:49:50AM +0100, Dujardin Bernard wrote:
>   
>> Index: tree.c
>> ===================================================================
>> --- tree.c	(revision 8131)
>> +++ tree.c	(working copy)
>> @@ -18,6 +18,12 @@
>>   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
>>   */
>>  
>> +/**
>> + * @file tree.c
>> + * A tree container implementation.
>> + * @author Michael Niedermayer <michaelni at gmx.at>
>> + */
>> +
>>  #include "common.h"
>>  #include "log.h"
>>  #include "tree.h"
>>     
>
>   
>> Index: tree.h
>> ===================================================================
>> --- tree.h	(revision 8131)
>> +++ tree.h	(working copy)
>> @@ -18,6 +18,13 @@
>>   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
>>   */
>>  
>> +
>> +/**
>> + * @file tree.h
>> + * A tree container implementation.
>>     
>
> s/implementation//
> theres no specific implementation in the header and emphasizing that for
> the c file also does nothing good
>
>   
I have removed it
>> + * @author Michael Niedermayer <michaelni at gmx.at>
>> + */
>> + 
>>  #ifndef TREE_H
>>  #define TREE_H
>>  
>> @@ -42,11 +49,16 @@
>>   *              keep the tree balanced
>>   *
>>   * @return if no insertion happened, the found element
>> - *         if a insertion happened, then either key or NULL is returned (which it is
>> - *         depends on the tree state and the implemenattion, you should make no
>> - *         asumtations that its one or the other in code)
>> + *         if a insertion happened, then either key or NULL is returned (that
>> + *         depends of the tree state and the implementation, you should make no
>> + *         assumptions that it is one or the other in the code)
>>   */
>>     
>
> "of" sounds wrong
> and i think its "an insertion"
>
>   
I did only little corrections :
if an insertion happened, then either key or NULL is returned (which it is
depends on the tree state and the implementation, you should make no
assumption that it is one or the other in the code)
>   
>>  void *av_tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b));
>> +
>> +/**
>> + * Destroy a node and node's childs.
>> + * @param t a pointer to the node.
>> + */
>>  void av_tree_destroy(struct AVTreeNode *t);
>>     
>
> not good, no comment is better then half wrong comments, what you
> write is as if i could call this with any node and it would delete
> its immedeate children or the whole branch neither is true it would
> crash your application if used like that
>   
I let it uncommented. I have not found cross-reference to it in Doxygen 
html generated doc.
Thanks

Bernard

-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: tree_h.patch
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070226/b2a2c575/attachment.txt>