summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Pool <mbp@samba.org>2003-02-28 04:21:55 +0000
committerMartin Pool <mbp@samba.org>2003-02-28 04:21:55 +0000
commit481b4e6d6ceeab644b5c4d1ee11bc221d8035202 (patch)
tree5c2f178ecebde4ba640e8d02ebf9e06b32ce8503
parentf5f59e866e5b761a6b0c95d29bb2d1ec0136652f (diff)
downloadsamba-481b4e6d6ceeab644b5c4d1ee11bc221d8035202.tar.gz
samba-481b4e6d6ceeab644b5c4d1ee11bc221d8035202.tar.bz2
samba-481b4e6d6ceeab644b5c4d1ee11bc221d8035202.zip
Doxygen janitor
(This used to be commit 9af07173152c5e861d13b33a8d4aee8167a50b66)
-rw-r--r--source3/lib/iconv.c2
-rw-r--r--source3/lib/messages.c14
-rw-r--r--source3/web/swat.c2
3 files changed, 9 insertions, 9 deletions
diff --git a/source3/lib/iconv.c b/source3/lib/iconv.c
index 6786003de5..8b360a14c6 100644
--- a/source3/lib/iconv.c
+++ b/source3/lib/iconv.c
@@ -35,7 +35,7 @@
* Samba only works with encodings that are supersets of ASCII: ascii
* characters like whitespace can be tested for directly, multibyte
* sequences start with a byte with the high bit set, and strings are
- * terminated by \0.
+ * terminated by a nul byte.
*
* Note that the only function provided by iconv is conversion between
* characters. It doesn't directly support operations like
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,
diff --git a/source3/web/swat.c b/source3/web/swat.c
index 4211b2f15a..d6693b4e75 100644
--- a/source3/web/swat.c
+++ b/source3/web/swat.c
@@ -21,7 +21,7 @@
*/
/**
- * @defgroup swat SWAT
+ * @defgroup swat SWAT - Samba Web Administration Tool
* @{
* @file swat.c
*