summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHavoc Pennington <hp@redhat.com>2003-04-05 19:09:49 +0000
committerHavoc Pennington <hp@redhat.com>2003-04-05 19:09:49 +0000
commit35ab7c6fab22dca58fc4b5c22b9e8587a6fd1492 (patch)
tree664c1c0420f6897d6e11665b06f9ac8aa4971702
parent2250539aeee0569f8861841d1f5ff16f1539715e (diff)
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
-rw-r--r--ChangeLog8
-rw-r--r--dbus/dbus-memory.c12
-rw-r--r--dbus/dbus-spawn.c11
-rw-r--r--dbus/dbus-string.c1
4 files changed, 26 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog
index d04731c9..a4bcafa6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
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
magic from GLib
diff --git a/dbus/dbus-memory.c b/dbus/dbus-memory.c
index 8efbec59..c42ef466 100644
--- 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 5fa2d5e8..2273a4e3 100644
--- 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 0bd754b3..b55cc892 100644
--- 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