summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHavoc Pennington <hp@redhat.com>2002-11-23 07:48:28 +0000
committerHavoc Pennington <hp@redhat.com>2002-11-23 07:48:28 +0000
commitf09921965c769ff6411ae2f684f6b855d4c8f38d (patch)
treeaefebf4c04e4da7d35e52b4a05b258cbbe31cf48
parent954c4c7550879bd80315811b8548adfcb415766e (diff)
2002-11-23 Havoc Pennington <hp@pobox.com>
* Doxyfile.in (INCLUDE_FILE_PATTERNS): expand DBUS_BEGIN_DECLS/ DBUS_END_DECLS to nothing, that should fix this once and for all * Doxyfile.in (JAVADOC_AUTOBRIEF): set to YES * dbus/dbus-message.c, dbus/dbus-hash.c: add some missing @brief
-rw-r--r--ChangeLog10
-rw-r--r--Doxyfile.in8
-rw-r--r--dbus/dbus-hash.c14
-rw-r--r--dbus/dbus-hash.h4
-rw-r--r--dbus/dbus-message.c2
-rw-r--r--dbus/dbus-message.h2
6 files changed, 28 insertions, 12 deletions
diff --git a/ChangeLog b/ChangeLog
index 08535c68..90371ec3 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,15 @@
2002-11-23 Havoc Pennington <hp@pobox.com>
+ * Doxyfile.in (INCLUDE_FILE_PATTERNS): expand DBUS_BEGIN_DECLS/
+ DBUS_END_DECLS to nothing, that should fix this once and for all
+
+ * Doxyfile.in (JAVADOC_AUTOBRIEF): set to YES
+
+ * dbus/dbus-message.c, dbus/dbus-hash.c:
+ add some missing @brief
+
+2002-11-23 Havoc Pennington <hp@pobox.com>
+
* dbus/dbus-message.h: put semicolons after DEBUG_BEGIN_DECLS
to avoid confusing Doxygen
diff --git a/Doxyfile.in b/Doxyfile.in
index c686f4b4..877b4ed5 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -24,7 +24,7 @@ SHORT_NAMES = NO
HIDE_SCOPE_NAMES = NO
VERBATIM_HEADERS = YES
SHOW_INCLUDE_FILES = YES
-JAVADOC_AUTOBRIEF = NO
+JAVADOC_AUTOBRIEF = YES
INHERIT_DOCS = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
@@ -138,12 +138,12 @@ GENERATE_XML = NO
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
-MACRO_EXPANSION = NO
-EXPAND_ONLY_PREDEF = NO
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
-PREDEFINED =
+PREDEFINED = "DBUS_BEGIN_DECLS=" "DBUS_END_DECLS="
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
diff --git a/dbus/dbus-hash.c b/dbus/dbus-hash.c
index 419a7848..77fa95dc 100644
--- a/dbus/dbus-hash.c
+++ b/dbus/dbus-hash.c
@@ -1,5 +1,5 @@
/* -*- mode: C; c-file-style: "gnu" -*- */
-/* dbus-hash.c Generic hash table utility (internal to D-BUS implementation)
+/* dbus-hash.c Generic hash table utility (internal to D-BUS implementation)
*
* Copyright (C) 2002 Red Hat, Inc.
* Copyright (c) 1991-1993 The Regents of the University of California.
@@ -123,6 +123,8 @@
typedef struct DBusHashEntry DBusHashEntry;
/**
+ * @brief Internal representation of a hash entry.
+ *
* A single entry (key-value pair) in the hash table.
* Internal to hash table implementation.
*/
@@ -145,8 +147,10 @@ typedef DBusHashEntry* (* DBusFindEntryFunction) (DBusHashTable *table,
DBusHashEntry ***bucket);
/**
- * Hash table internal members. Hash tables are opaque objects,
- * they must be used via accessor functions.
+ * @brief Internals of DBusHashTable.
+ *
+ * Hash table internals. Hash tables are opaque objects, they must be
+ * used via accessor functions.
*/
struct DBusHashTable {
int refcount; /**< Reference count */
@@ -184,8 +188,8 @@ struct DBusHashTable {
DBusFreeFunction free_value_function; /**< Function to free values */
};
-/**
- * Internals of DBusHashIter.
+/**
+ * @brief Internals of DBusHashIter.
*/
typedef struct
{
diff --git a/dbus/dbus-hash.h b/dbus/dbus-hash.h
index 267b2e94..b8136524 100644
--- a/dbus/dbus-hash.h
+++ b/dbus/dbus-hash.h
@@ -1,6 +1,6 @@
/* -*- mode: C; c-file-style: "gnu" -*- */
-/* dbus-hash.h Generic hash table utility (internal to D-BUS implementation)
- *
+/* dbus-hash.h Generic hash table utility (internal to D-BUS implementation)
+ *
* Copyright (C) 2002 Red Hat, Inc.
*
* Licensed under the Academic Free License version 1.2
diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c
index fdc0c342..a52d7097 100644
--- a/dbus/dbus-message.c
+++ b/dbus/dbus-message.c
@@ -34,6 +34,8 @@
*/
/**
+ * @brief Internals of DBusMessage
+ *
* Object representing a message received from or to be sent to
* another application. This is an opaque object, all members
* are private.
diff --git a/dbus/dbus-message.h b/dbus/dbus-message.h
index d86f5d23..ce618388 100644
--- a/dbus/dbus-message.h
+++ b/dbus/dbus-message.h
@@ -1,5 +1,5 @@
/* -*- mode: C; c-file-style: "gnu" -*- */
-/* dbus-message.h DBusMessage object
+/* dbus-message.h DBusMessage object
*
* Copyright (C) 2002 Red Hat Inc.
*