diff options
| -rw-r--r-- | ChangeLog | 12 | ||||
| -rw-r--r-- | Doxyfile | 10 | ||||
| -rw-r--r-- | dbus/dbus-message.c | 43 | ||||
| -rw-r--r-- | dbus/dbus-message.h | 29 |
4 files changed, 60 insertions, 34 deletions
@@ -1,3 +1,15 @@ +2002-11-22 Havoc Pennington <hp@redhat.com> + + * dbus/dbus-message.c: move inline docs into .c file + + * Doxyfile (OUTPUT_DIRECTORY): move output to doc/api + so all docs are under doc/ + (MAN_EXTENSION): generate man pages. Use extension + ".3dbus" which matches ".3qt" on my system, + I guess this is OK, I don't know really. + (FILE_PATTERNS): look for .c files not .h, makes sense + for plain C I think + 2002-11-22 Havoc Pennington <hp@pobox.com> * Makefile.am (SUBDIRS): rename subdir "server" to "bus" @@ -5,7 +5,7 @@ #--------------------------------------------------------------------------- PROJECT_NAME = DBus PROJECT_NUMBER = 1.0 -OUTPUT_DIRECTORY = apidocs +OUTPUT_DIRECTORY = doc/api OUTPUT_LANGUAGE = English EXTRACT_ALL = NO EXTRACT_PRIVATE = NO @@ -49,8 +49,8 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = dbus server -FILE_PATTERNS = *.h +INPUT = dbus bus +FILE_PATTERNS = *.c RECURSIVE = YES #EXCLUDE = test @@ -126,9 +126,9 @@ RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -GENERATE_MAN = NO +GENERATE_MAN = YES MAN_OUTPUT = man -MAN_EXTENSION = .dbus +MAN_EXTENSION = .3dbus MAN_LINKS = YES #--------------------------------------------------------------------------- # configuration options related to the XML output diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c index 08a5c9d3..4bda9481 100644 --- a/dbus/dbus-message.c +++ b/dbus/dbus-message.c @@ -23,15 +23,58 @@ #include "dbus-message.h" +/** + * @defgroup DBusMessage + * @ingroup DBus + * @brief DBusMessage object + * + * Types and functions related to the DBusMessage object. + * + * @{ + */ + struct DBusMessage { int refcount; }; +/** + * Constructs a new message. + * @return a new DBusMessage, free with dbus_message_unref() + * @see dbus_message_unref() + */ DBusMessage* dbus_message_new (void) { return NULL; } + + +/** + * Increments the reference count of a DBusMessage. + * + * @arg message The message + * @see dbus_message_unref + */ +void +dbus_message_ref (DBusMessage *message) +{ + +} + +/** + * Decrements the reference count of a DBusMessage. + * + * @arg message The message + * @see dbus_message_ref + */ +void +dbus_message_unref (DBusMessage *message) +{ + + +} + +/** @} */ diff --git a/dbus/dbus-message.h b/dbus/dbus-message.h index 73f6599f..8c69d06f 100644 --- a/dbus/dbus-message.h +++ b/dbus/dbus-message.h @@ -31,43 +31,14 @@ DBUS_BEGIN_DECLS -/** - * @defgroup Message - * @ingroup DBus - * @brief Message handling. - * - * This functions deal with message structure - * within DBus. - * - * @{ - */ - typedef struct DBusMessage DBusMessage; -/** - * Constructs a new DBus message. - * @return New DBusMessage - */ DBusMessage* dbus_message_new (void); -/** - * Increments a reference count on a message. - * - * @arg message It's the message whose reference count we're incrementing - * @see dbus_message_unref - */ void dbus_message_ref (DBusMessage *message); - -/** - * Decrements a reference count on a message. - * - * @arg message It's the message whose reference count we're decrementing - */ void dbus_message_unref (DBusMessage *message); -/** @} */ - DBUS_END_DECLS #endif /* DBUS_MESSAGE_H */ |