From 45d3e78547cb2024d9cf7bf1fc838dd33ad8126b Mon Sep 17 00:00:00 2001 From: Andrew Bartlett Date: Mon, 17 Mar 2003 22:42:56 +0000 Subject: Mege from HEAD - doxygen. (This used to be commit 04a5cbc8964386774acdca759b4cfaded068c8f2) --- source3/lib/messages.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'source3/lib/messages.c') diff --git a/source3/lib/messages.c b/source3/lib/messages.c index 3603758e9f..5ff0e45c61 100644 --- a/source3/lib/messages.c +++ b/source3/lib/messages.c @@ -21,11 +21,11 @@ */ /** - @defgroups messages Internal messaging framework - @{ - @file messages.c - - This module is used for internal messaging between Samba daemons. + @defgroup messages Internal messaging framework + @{ + @file messages.c + + @brief Module for internal messaging between Samba daemons. The idea is that if a part of Samba wants to do communication with another Samba process then it will do a message_register() of a @@ -36,7 +36,7 @@ use that to reply by message_send_pid(). See ping_message() for a simple example. - *NOTE*: Dispatch functions must be able to cope with incoming + @caution Dispatch functions must be able to cope with incoming messages on an *odd* byte boundary. This system doesn't have any inherent size limitations but is not @@ -524,7 +524,7 @@ static int traverse_fn(TDB_CONTEXT *the_tdb, TDB_DATA kbuf, TDB_DATA dbuf, void * @param n_sent Set to the number of messages sent. This should be * equal to the number of processes, but be careful for races. * - * @return True for success. + * @retval True for success. **/ BOOL message_send_all(TDB_CONTEXT *conn_tdb, int msg_type, const void *buf, size_t len, -- cgit