summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-macros.h
diff options
context:
space:
mode:
authorHavoc Pennington <hp@redhat.com>2002-11-23 06:53:37 +0000
committerHavoc Pennington <hp@redhat.com>2002-11-23 06:53:37 +0000
commit1428c65e7c46fd9f52e43b7424c56552ec2686e8 (patch)
tree70ff2e7b4f1fcc9e89d084e7fc257bdc02ae3384 /dbus/dbus-macros.h
parentca8603a9eaa0d639ecf96526ac58c534314c9f23 (diff)
2002-11-23 Havoc Pennington <hp@pobox.com>
* configure.in: pile on more warning flags if using gcc * Doxyfile.in (EXTRACT_STATIC): set to NO, so we don't have to document static functions * configure.in: add summary to end of configure so it looks nice and attractive * dbus/dbus-hash.c: finish implementation and write unit tests and docs * configure.in: add --enable-tests to enable unit tests * dbus/dbus-test.c: test program to run unit tests for all files in dbus/*, initially runs a test for dbus-hash.c * dbus/dbus-internals.h: file to hold some internal utility stuff
Diffstat (limited to 'dbus/dbus-macros.h')
-rw-r--r--dbus/dbus-macros.h43
1 files changed, 43 insertions, 0 deletions
diff --git a/dbus/dbus-macros.h b/dbus/dbus-macros.h
index 413eca5d..8b341de7 100644
--- a/dbus/dbus-macros.h
+++ b/dbus/dbus-macros.h
@@ -50,4 +50,47 @@
# endif /* !__cplusplus */
#endif
+/* Normally docs are in .c files, but there isn't a .c file for this. */
+/**
+ * @defgroup DBusMacros Utility macros
+ * @ingroup DBus
+ * @brief #TRUE, #FALSE, #NULL, and so on
+ *
+ * Utility macros.
+ *
+ * @{
+ */
+
+/**
+ * @def DBUS_BEGIN_DECLS
+ *
+ * Macro used prior to declaring functions in the D-BUS header
+ * files. Expands to "extern "C"" when using a C++ compiler,
+ * and expands to nothing when using a C compiler.
+ */
+/**
+ * @def DBUS_END_DECLS
+ *
+ * Macro used after declaring functions in the D-BUS header
+ * files. Expands to "}" when using a C++ compiler,
+ * and expands to nothing when using a C compiler.
+ */
+/**
+ * @def TRUE
+ *
+ * Expands to "1"
+ */
+/**
+ * @def FALSE
+ *
+ * Expands to "0"
+ */
+/**
+ * @def NULL
+ *
+ * A null pointer, defined appropriately for C or C++.
+ */
+
+/** }@ */
+
#endif /* DBUS_MACROS_H */