bugTransport Sample Protocol - Bugs: bug #23927, Bad doxygen documentation for...

 
 

bug #23927: Bad doxygen documentation for bb_snd_msg and bb_rcv_msg

Submitted by:  Jerome Arbez-Gindre <jaggy>
Submitted on:  Thu 24 Jul 2008 01:17:13 PM UTC  
 
Category:  Blackboard Severity:  4 - Important
Status:  Fixed Privacy:  Public
Assigned to:  Jerome Arbez-Gindre <jaggy> Open/Closed:  Open
Release:  CVS Fixed Release:  NextRelease

Add a New Comment (Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Thu 24 Jul 2008 01:28:51 PM UTC, comment #1: 

Fixed:
src/util/libbb/bb_core.c (rev 1.59)
src/util/libbb/bb_core.h (rev 1.46)

For bb_snd_msg and bb_rcv_msg:
- Make Doxygen comment fit with behavior.
- Replace return type int32_t by ssize_t (equivalent but closer to the send/receive semantic)

Jerome Arbez-Gindre <jaggy>
Project MemberIn charge of this item.
Thu 24 Jul 2008 01:17:13 PM UTC, original submission:  

Both function have the folowing doxygen comment:

@return BB_OK on success BB_NOK otherwise.

But they both return:
The size of the sent message on success and -1 otherwise.

Jerome Arbez-Gindre <jaggy>
Project MemberIn charge of this item.

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by jaggy (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

     

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2008-07-24 jaggy StatusIn Progress => Fixed
    2008-07-24 jaggy SummaryBad doxugen documentation for bb_snd_msg and bb_rcv_msg => Bad doxygen documentation for bb_snd_msg and bb_rcv_msg

    Back to the top


    Powered by Savane 3.5