Fix doxygen to use new macro conventions

This commit is contained in:
Nick Mathewson 2012-02-29 15:48:59 -05:00
parent 946b5841c2
commit da455e92f5
7 changed files with 19 additions and 19 deletions

View File

@ -239,7 +239,7 @@ INCLUDE_FILE_PATTERNS =
# undefined via #undef or recursively expanded use the := operator # undefined via #undef or recursively expanded use the := operator
# instead of the = operator. # instead of the = operator.
PREDEFINED = TAILQ_ENTRY RB_ENTRY _EVENT_DEFINED_TQENTRY _EVENT_IN_DOXYGEN PREDEFINED = TAILQ_ENTRY RB_ENTRY EVENT_DEFINED_TQENTRY_ EVENT_IN_DOXYGEN_
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded. # this tag can be used to specify a list of macro names that should be expanded.

View File

@ -93,7 +93,7 @@ extern "C" {
@see event2/event.h for more information @see event2/event.h for more information
*/ */
struct evbuffer struct evbuffer
#ifdef _EVENT_IN_DOXYGEN #ifdef EVENT_IN_DOXYGEN_
{} {}
#endif #endif
; ;

View File

@ -109,7 +109,7 @@ extern "C" {
@see event2/bufferevent.h @see event2/bufferevent.h
*/ */
struct bufferevent struct bufferevent
#ifdef _EVENT_IN_DOXYGEN #ifdef EVENT_IN_DOXYGEN_
{} {}
#endif #endif
; ;

View File

@ -52,7 +52,7 @@ enum bufferevent_ssl_state {
BUFFEREVENT_SSL_ACCEPTING = 2 BUFFEREVENT_SSL_ACCEPTING = 2
}; };
#if defined(EVENT__HAVE_OPENSSL) || defined(_EVENT_IN_DOXYGEN) #if defined(EVENT__HAVE_OPENSSL) || defined(EVENT_IN_DOXYGEN_)
/** /**
Create a new SSL bufferevent to send its data over another bufferevent. Create a new SSL bufferevent to send its data over another bufferevent.

View File

@ -211,7 +211,7 @@ extern "C" {
* event_base_new_with_config() * event_base_new_with_config()
*/ */
struct event_base struct event_base
#ifdef _EVENT_IN_DOXYGEN #ifdef EVENT_IN_DOXYGEN_
{/*Empty body so that doxygen will generate documentation here.*/} {/*Empty body so that doxygen will generate documentation here.*/}
#endif #endif
; ;
@ -270,7 +270,7 @@ struct event_base
* event_priority_set() * event_priority_set()
*/ */
struct event struct event
#ifdef _EVENT_IN_DOXYGEN #ifdef EVENT_IN_DOXYGEN_
{/*Empty body so that doxygen will generate documentation here.*/} {/*Empty body so that doxygen will generate documentation here.*/}
#endif #endif
; ;
@ -289,7 +289,7 @@ struct event
* event_config_set_flag(), event_config_set_num_cpus_hint() * event_config_set_flag(), event_config_set_num_cpus_hint()
*/ */
struct event_config struct event_config
#ifdef _EVENT_IN_DOXYGEN #ifdef EVENT_IN_DOXYGEN_
{/*Empty body so that doxygen will generate documentation here.*/} {/*Empty body so that doxygen will generate documentation here.*/}
#endif #endif
; ;
@ -1214,7 +1214,7 @@ int event_priority_set(struct event *, int);
const struct timeval *event_base_init_common_timeout(struct event_base *base, const struct timeval *event_base_init_common_timeout(struct event_base *base,
const struct timeval *duration); const struct timeval *duration);
#if !defined(EVENT__DISABLE_MM_REPLACEMENT) || defined(_EVENT_IN_DOXYGEN) #if !defined(EVENT__DISABLE_MM_REPLACEMENT) || defined(EVENT_IN_DOXYGEN_)
/** /**
Override the functions that Libevent uses for memory management. Override the functions that Libevent uses for memory management.

View File

@ -69,7 +69,7 @@ extern "C" {
#define EVTHREAD_TRY 0x10 #define EVTHREAD_TRY 0x10
/**@}*/ /**@}*/
#if !defined(EVENT__DISABLE_THREAD_SUPPORT) || defined(_EVENT_IN_DOXYGEN) #if !defined(EVENT__DISABLE_THREAD_SUPPORT) || defined(EVENT_IN_DOXYGEN_)
#define EVTHREAD_LOCK_API_VERSION 1 #define EVTHREAD_LOCK_API_VERSION 1
@ -187,7 +187,7 @@ int evthread_set_condition_callbacks(
void evthread_set_id_callback( void evthread_set_id_callback(
unsigned long (*id_fn)(void)); unsigned long (*id_fn)(void));
#if (defined(_WIN32) && !defined(EVENT__DISABLE_THREAD_SUPPORT)) || defined(_EVENT_IN_DOXYGEN) #if (defined(_WIN32) && !defined(EVENT__DISABLE_THREAD_SUPPORT)) || defined(EVENT_IN_DOXYGEN_)
/** Sets up Libevent for use with Windows builtin locking and thread ID /** Sets up Libevent for use with Windows builtin locking and thread ID
functions. Unavailable if Libevent is not built for Windows. functions. Unavailable if Libevent is not built for Windows.
@ -199,7 +199,7 @@ int evthread_use_windows_threads(void);
#define EVTHREAD_USE_WINDOWS_THREADS_IMPLEMENTED 1 #define EVTHREAD_USE_WINDOWS_THREADS_IMPLEMENTED 1
#endif #endif
#if defined(EVENT__HAVE_PTHREADS) || defined(_EVENT_IN_DOXYGEN) #if defined(EVENT__HAVE_PTHREADS) || defined(EVENT_IN_DOXYGEN_)
/** Sets up Libevent for use with Pthreads locking and thread ID functions. /** Sets up Libevent for use with Pthreads locking and thread ID functions.
Unavailable if Libevent is not build for use with pthreads. Requires Unavailable if Libevent is not build for use with pthreads. Requires
libraries to link against Libevent_pthreads as well as Libevent. libraries to link against Libevent_pthreads as well as Libevent.

View File

@ -115,7 +115,7 @@ extern "C" {
#elif EVENT__SIZEOF_LONG == 8 #elif EVENT__SIZEOF_LONG == 8
#define ev_uint64_t unsigned long #define ev_uint64_t unsigned long
#define ev_int64_t long #define ev_int64_t long
#elif defined(_EVENT_IN_DOXYGEN) #elif defined(EVENT_IN_DOXYGEN_)
#define ev_uint64_t ... #define ev_uint64_t ...
#define ev_int64_t ... #define ev_int64_t ...
#else #else
@ -134,7 +134,7 @@ extern "C" {
#elif EVENT__SIZEOF_INT == 4 #elif EVENT__SIZEOF_INT == 4
#define ev_uint32_t unsigned int #define ev_uint32_t unsigned int
#define ev_int32_t signed int #define ev_int32_t signed int
#elif defined(_EVENT_IN_DOXYGEN) #elif defined(EVENT_IN_DOXYGEN_)
#define ev_uint32_t ... #define ev_uint32_t ...
#define ev_int32_t ... #define ev_int32_t ...
#else #else
@ -153,7 +153,7 @@ extern "C" {
#elif EVENT__SIZEOF_SHORT == 2 #elif EVENT__SIZEOF_SHORT == 2
#define ev_uint16_t unsigned short #define ev_uint16_t unsigned short
#define ev_int16_t signed short #define ev_int16_t signed short
#elif defined(_EVENT_IN_DOXYGEN) #elif defined(EVENT_IN_DOXYGEN_)
#define ev_uint16_t ... #define ev_uint16_t ...
#define ev_int16_t ... #define ev_int16_t ...
#else #else
@ -163,7 +163,7 @@ extern "C" {
#ifdef EVENT__HAVE_UINT8_T #ifdef EVENT__HAVE_UINT8_T
#define ev_uint8_t uint8_t #define ev_uint8_t uint8_t
#define ev_int8_t int8_t #define ev_int8_t int8_t
#elif defined(_EVENT_IN_DOXYGEN) #elif defined(EVENT_IN_DOXYGEN_)
#define ev_uint8_t ... #define ev_uint8_t ...
#define ev_int8_t ... #define ev_int8_t ...
#else #else
@ -180,7 +180,7 @@ extern "C" {
#elif EVENT__SIZEOF_VOID_P <= 8 #elif EVENT__SIZEOF_VOID_P <= 8
#define ev_uintptr_t ev_uint64_t #define ev_uintptr_t ev_uint64_t
#define ev_intptr_t ev_int64_t #define ev_intptr_t ev_int64_t
#elif defined(_EVENT_IN_DOXYGEN) #elif defined(EVENT_IN_DOXYGEN_)
#define ev_uintptr_t ... #define ev_uintptr_t ...
#define ev_intptr_t ... #define ev_intptr_t ...
#else #else
@ -206,7 +206,7 @@ extern "C" {
#define ev_off_t ev_int64_t #define ev_off_t ev_int64_t
#elif EVENT__SIZEOF_OFF_T == 4 #elif EVENT__SIZEOF_OFF_T == 4
#define ev_off_t ev_int32_t #define ev_off_t ev_int32_t
#elif defined(_EVENT_IN_DOXYGEN) #elif defined(EVENT_IN_DOXYGEN_)
#define ev_off_t ... #define ev_off_t ...
#else #else
#define ev_off_t off_t #define ev_off_t off_t
@ -253,7 +253,7 @@ extern "C" {
#elif EVENT__SIZEOF_SIZE_T == 4 #elif EVENT__SIZEOF_SIZE_T == 4
#define EV_SIZE_MAX EV_UINT32_MAX #define EV_SIZE_MAX EV_UINT32_MAX
#define EV_SSIZE_MAX EV_INT32_MAX #define EV_SSIZE_MAX EV_INT32_MAX
#elif defined(_EVENT_IN_DOXYGEN) #elif defined(EVENT_IN_DOXYGEN_)
#define EV_SIZE_MAX ... #define EV_SIZE_MAX ...
#define EV_SSIZE_MAX ... #define EV_SSIZE_MAX ...
#else #else
@ -359,7 +359,7 @@ int evutil_make_tcp_listen_socket_deferred(evutil_socket_t sock);
int evutil_socket_geterror(evutil_socket_t sock); int evutil_socket_geterror(evutil_socket_t sock);
/** Convert a socket error to a string. */ /** Convert a socket error to a string. */
const char *evutil_socket_error_to_string(int errcode); const char *evutil_socket_error_to_string(int errcode);
#elif defined(_EVENT_IN_DOXYGEN) #elif defined(EVENT_IN_DOXYGEN_)
/** /**
@name Socket error functions @name Socket error functions