[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [tsp-devel] bb_snd_msg/bb_rcv_msg doxygen
From: |
Eric Noulard |
Subject: |
Re: [tsp-devel] bb_snd_msg/bb_rcv_msg doxygen |
Date: |
Thu, 24 Jul 2008 12:51:49 +0200 |
2008/7/21, Jerome Arbez-Gindre <address@hidden>:
> Hi TSP people,
>
> In tsp/src/util/libbb/bb_core.h, for both bb_snd_msg and bb_rcv_msg functions,
> the doxygen doxumentation says:
>
> @return BB_OK on success, BB_NOK otherwise
[...]
>
> in fact in the implentation... at the begining of each function, the
> statement :
>
> retcode = BB_OK
>
> misleads en the fact that BB_OK should be return.
This is OK for most bb_xxx API but not this one...
> I propose:
> - Change the docygen comment.
> - change the implementation and replace in these functions the BB_xxx
> sementic by a -1, size semantic.
Personnally I'm OK with the change since the current behavior is buggy anyway.
Would you open a bug report for this in order to be able to track the change?
--
Erk