2003-04-05 Havoc Pennington <hp@pobox.com>

	* dbus/dbus-string.c: docs warning

	* dbus/dbus-spawn.c: missing docs

	* dbus/dbus-memory.c (struct ShutdownClosure): missing docs

diff --git a/ChangeLog b/ChangeLog
index d04731c92f79c3371fd1896acb108518a97b0513..a4bcafa6a29278cff3d92d932ccce95713c3553e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2003-04-05  Havoc Pennington  <hp@pobox.com>
+
+       * dbus/dbus-string.c: docs warning
+       
+       * dbus/dbus-spawn.c: missing docs
+
+       * dbus/dbus-memory.c (struct ShutdownClosure): missing docs
+
 2003-04-05  Havoc Pennington  <hp@pobox.com>
 
        * bus/loop.c (bus_loop_iterate): fix the timeout code, using 

diff --git a/dbus/dbus-memory.c b/dbus/dbus-memory.c
index 8efbec591e237cae2a68640e83771c9814c15e8d..c42ef46615dc8bb7be0073a7166160f73b078608 100644 (file)
--- a/dbus/dbus-memory.c
+++ b/dbus/dbus-memory.c
@@ -633,13 +633,19 @@ dbus_free_string_array (char **str_array)
  */
 int _dbus_current_generation = 1;
 
+/**
+ * Represents a function to be called on shutdown.
+ */
 typedef struct ShutdownClosure ShutdownClosure;
 
+/**
+ * This struct represents a function to be called on shutdown.
+ */
 struct ShutdownClosure
 {
-  ShutdownClosure *next;
-  DBusShutdownFunction func;
-  void *data;
+  ShutdownClosure *next;     /**< Next ShutdownClosure */
+  DBusShutdownFunction func; /**< Function to call */
+  void *data;                /**< Data for function */
 };
 
 _DBUS_DEFINE_GLOBAL_LOCK (shutdown_funcs);

diff --git a/dbus/dbus-spawn.c b/dbus/dbus-spawn.c
index 5fa2d5e83340461318e7451421a5d5b85a44e2c4..2273a4e32d08abf7d4bdbe7d08ca0f371c40444b 100644 (file)
--- a/dbus/dbus-spawn.c
+++ b/dbus/dbus-spawn.c
@@ -42,11 +42,14 @@
  * if you thought about it a bit.
  */
 
+/**
+ * Enumeration for status of a read()
+ */
 typedef enum
 {
-  READ_STATUS_OK,
-  READ_STATUS_ERROR,
-  READ_STATUS_EOF
+  READ_STATUS_OK,    /**< Read succeeded */
+  READ_STATUS_ERROR, /**< Some kind of error */
+  READ_STATUS_EOF    /**< EOF returned */
 } ReadStatus;
 
 static ReadStatus
@@ -709,7 +712,9 @@ _dbus_babysitter_handle_watch (DBusBabysitter  *sitter,
   return TRUE;
 }
 
+/** Helps remember which end of the pipe is which */
 #define READ_END 0
+/** Helps remember which end of the pipe is which */
 #define WRITE_END 1
 
 

diff --git a/dbus/dbus-string.c b/dbus/dbus-string.c
index 0bd754b39afa72229a42fe175a985c59b7365dda..b55cc892ae14afccecf1d6d453856efa9ce55ea6 100644 (file)
--- a/dbus/dbus-string.c
+++ b/dbus/dbus-string.c
@@ -1462,6 +1462,7 @@ _dbus_string_find_to (const DBusString *str,
  * Sets *found to -1 if the byte is not found.
  *
  * @param str the string
+ * @param start the place to start scanning (will not find the byte at this point)
  * @param byte the byte to find
  * @param found return location for where it was found
  * @returns #TRUE if found