Commit 71605908 authored by Havoc Pennington's avatar Havoc Pennington

2006-10-21 Havoc Pennington <hp@redhat.com>

	* dbus/dbus-macros.h: add DBUS_GNUC_DEPRECATED macro

	* dbus/dbus-message.h: mark dbus_message_iter_get_array_len()
	as DBUS_GNUC_DEPRECATED
parent 174c63f1
2006-10-21 Havoc Pennington <hp@redhat.com>
* dbus/dbus-macros.h: add DBUS_GNUC_DEPRECATED macro
* dbus/dbus-message.h: mark dbus_message_iter_get_array_len()
as DBUS_GNUC_DEPRECATED
2006-10-21 Havoc Pennington <hp@redhat.com>
* Move all private API into the private Doxygen group sections of
......
......@@ -146,6 +146,7 @@ INCLUDE_FILE_PATTERNS =
PREDEFINED = "DBUS_BEGIN_DECLS=" \
"DBUS_END_DECLS=" \
"DOXYGEN_SHOULD_SKIP_THIS" \
"DBUS_GNUC_DEPRECATED=" \
"_DBUS_DEFINE_GLOBAL_LOCK(name)=" \
"_DBUS_GNUC_PRINTF(from,to)="
SKIP_FUNCTION_MACROS = YES
......
......@@ -50,6 +50,12 @@
# endif /* !__cplusplus */
#endif
#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
#define DBUS_GNUC_DEPRECATED __attribute__((__deprecated__))
#else
#define DBUS_GNUC_DEPRECATED
#endif
/* Normally docs are in .c files, but there isn't a .c file for this. */
/**
* @defgroup DBusMacros Utility macros
......@@ -67,6 +73,9 @@
* 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.
*
* Please don't use this in your own code, consider it
* D-Bus internal.
*/
/**
* @def DBUS_END_DECLS
......@@ -74,6 +83,9 @@
* 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.
*
* Please don't use this in your own code, consider it
* D-Bus internal.
*/
/**
* @def TRUE
......@@ -90,6 +102,20 @@
*
* A null pointer, defined appropriately for C or C++.
*/
/**
* @def DBUS_GNUC_DEPRECATED
*
* Tells gcc to warn about a function or type if it's used.
* Code marked in this way should also be enclosed in
* @code
* #ifndef DBUS_DISABLE_DEPRECATED
* deprecated stuff here
* #endif
* @endcode
*
* Please don't use this in your own code, consider it
* D-Bus internal.
*/
/** @} */
......
......@@ -1255,6 +1255,9 @@ dbus_message_new_error (DBusMessage *reply_to,
* See dbus_message_new_error() for details - this function is the same
* aside from the printf formatting.
*
* @todo add _DBUS_GNUC_PRINTF to this (requires moving _DBUS_GNUC_PRINTF to
* public header, see DBUS_GNUC_DEPRECATED for an example)
*
* @param reply_to the original message
* @param error_name the error name
* @param error_format the error message format as with printf
......
......@@ -167,7 +167,7 @@ void dbus_message_iter_get_basic (DBusMessageIter *iter,
/* This function returns the wire protocol size of the array in bytes,
* you do not want to know that probably
*/
int dbus_message_iter_get_array_len (DBusMessageIter *iter);
int dbus_message_iter_get_array_len (DBusMessageIter *iter) DBUS_GNUC_DEPRECATED;
#endif
void dbus_message_iter_get_fixed_array (DBusMessageIter *iter,
void *value,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment