Doxygen janitor
authorMartin Pool <mbp@samba.org>
Fri, 28 Feb 2003 04:21:55 +0000 (04:21 +0000)
committerMartin Pool <mbp@samba.org>
Fri, 28 Feb 2003 04:21:55 +0000 (04:21 +0000)
(This used to be commit 9af07173152c5e861d13b33a8d4aee8167a50b66)

source3/lib/iconv.c
source3/lib/messages.c
source3/web/swat.c

index 6786003de570b64d86dd8468c0a9564a3130f6a3..8b360a14c622d64d50030858d24e8f30d28686f8 100644 (file)
@@ -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
index 3603758e9fec22f960858074413842360e34fbdc..5ff0e45c61fc1429ef0228cbb7858b403e779758 100644 (file)
 */
 
 /**
-   @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,
index 4211b2f15a96e0108ab7388c3f87cfe673a48ab7..d6693b4e75085441f866a0c56820b554b0aca534 100644 (file)
@@ -21,7 +21,7 @@
 */
 
 /**
- * @defgroup swat SWAT
+ * @defgroup swat SWAT - Samba Web Administration Tool
  * @{ 
  * @file swat.c
  *