From da455e92f5e8d946835d7ced883e4739d0234108 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Wed, 29 Feb 2012 15:48:59 -0500 Subject: [PATCH] Fix doxygen to use new macro conventions --- Doxyfile | 2 +- include/event2/buffer.h | 2 +- include/event2/bufferevent.h | 2 +- include/event2/bufferevent_ssl.h | 2 +- include/event2/event.h | 8 ++++---- include/event2/thread.h | 6 +++--- include/event2/util.h | 16 ++++++++-------- 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/Doxyfile b/Doxyfile index 5d3865e7..d9d66034 100644 --- a/Doxyfile +++ b/Doxyfile @@ -239,7 +239,7 @@ INCLUDE_FILE_PATTERNS = # undefined via #undef or recursively expanded use 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 # this tag can be used to specify a list of macro names that should be expanded. diff --git a/include/event2/buffer.h b/include/event2/buffer.h index c26cd2fb..ad0013fc 100644 --- a/include/event2/buffer.h +++ b/include/event2/buffer.h @@ -93,7 +93,7 @@ extern "C" { @see event2/event.h for more information */ struct evbuffer -#ifdef _EVENT_IN_DOXYGEN +#ifdef EVENT_IN_DOXYGEN_ {} #endif ; diff --git a/include/event2/bufferevent.h b/include/event2/bufferevent.h index 85cdf71a..a4a6c998 100644 --- a/include/event2/bufferevent.h +++ b/include/event2/bufferevent.h @@ -109,7 +109,7 @@ extern "C" { @see event2/bufferevent.h */ struct bufferevent -#ifdef _EVENT_IN_DOXYGEN +#ifdef EVENT_IN_DOXYGEN_ {} #endif ; diff --git a/include/event2/bufferevent_ssl.h b/include/event2/bufferevent_ssl.h index b0bd82fc..2b7e6141 100644 --- a/include/event2/bufferevent_ssl.h +++ b/include/event2/bufferevent_ssl.h @@ -52,7 +52,7 @@ enum bufferevent_ssl_state { 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. diff --git a/include/event2/event.h b/include/event2/event.h index 7b14433b..54871eeb 100644 --- a/include/event2/event.h +++ b/include/event2/event.h @@ -211,7 +211,7 @@ extern "C" { * event_base_new_with_config() */ struct event_base -#ifdef _EVENT_IN_DOXYGEN +#ifdef EVENT_IN_DOXYGEN_ {/*Empty body so that doxygen will generate documentation here.*/} #endif ; @@ -270,7 +270,7 @@ struct event_base * event_priority_set() */ struct event -#ifdef _EVENT_IN_DOXYGEN +#ifdef EVENT_IN_DOXYGEN_ {/*Empty body so that doxygen will generate documentation here.*/} #endif ; @@ -289,7 +289,7 @@ struct event * event_config_set_flag(), event_config_set_num_cpus_hint() */ struct event_config -#ifdef _EVENT_IN_DOXYGEN +#ifdef EVENT_IN_DOXYGEN_ {/*Empty body so that doxygen will generate documentation here.*/} #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 *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. diff --git a/include/event2/thread.h b/include/event2/thread.h index 43b58d08..2a8c09a5 100644 --- a/include/event2/thread.h +++ b/include/event2/thread.h @@ -69,7 +69,7 @@ extern "C" { #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 @@ -187,7 +187,7 @@ int evthread_set_condition_callbacks( void evthread_set_id_callback( 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 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 #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. Unavailable if Libevent is not build for use with pthreads. Requires libraries to link against Libevent_pthreads as well as Libevent. diff --git a/include/event2/util.h b/include/event2/util.h index 4ca4a262..68754c7a 100644 --- a/include/event2/util.h +++ b/include/event2/util.h @@ -115,7 +115,7 @@ extern "C" { #elif EVENT__SIZEOF_LONG == 8 #define ev_uint64_t unsigned long #define ev_int64_t long -#elif defined(_EVENT_IN_DOXYGEN) +#elif defined(EVENT_IN_DOXYGEN_) #define ev_uint64_t ... #define ev_int64_t ... #else @@ -134,7 +134,7 @@ extern "C" { #elif EVENT__SIZEOF_INT == 4 #define ev_uint32_t unsigned int #define ev_int32_t signed int -#elif defined(_EVENT_IN_DOXYGEN) +#elif defined(EVENT_IN_DOXYGEN_) #define ev_uint32_t ... #define ev_int32_t ... #else @@ -153,7 +153,7 @@ extern "C" { #elif EVENT__SIZEOF_SHORT == 2 #define ev_uint16_t unsigned short #define ev_int16_t signed short -#elif defined(_EVENT_IN_DOXYGEN) +#elif defined(EVENT_IN_DOXYGEN_) #define ev_uint16_t ... #define ev_int16_t ... #else @@ -163,7 +163,7 @@ extern "C" { #ifdef EVENT__HAVE_UINT8_T #define ev_uint8_t uint8_t #define ev_int8_t int8_t -#elif defined(_EVENT_IN_DOXYGEN) +#elif defined(EVENT_IN_DOXYGEN_) #define ev_uint8_t ... #define ev_int8_t ... #else @@ -180,7 +180,7 @@ extern "C" { #elif EVENT__SIZEOF_VOID_P <= 8 #define ev_uintptr_t ev_uint64_t #define ev_intptr_t ev_int64_t -#elif defined(_EVENT_IN_DOXYGEN) +#elif defined(EVENT_IN_DOXYGEN_) #define ev_uintptr_t ... #define ev_intptr_t ... #else @@ -206,7 +206,7 @@ extern "C" { #define ev_off_t ev_int64_t #elif EVENT__SIZEOF_OFF_T == 4 #define ev_off_t ev_int32_t -#elif defined(_EVENT_IN_DOXYGEN) +#elif defined(EVENT_IN_DOXYGEN_) #define ev_off_t ... #else #define ev_off_t off_t @@ -253,7 +253,7 @@ extern "C" { #elif EVENT__SIZEOF_SIZE_T == 4 #define EV_SIZE_MAX EV_UINT32_MAX #define EV_SSIZE_MAX EV_INT32_MAX -#elif defined(_EVENT_IN_DOXYGEN) +#elif defined(EVENT_IN_DOXYGEN_) #define EV_SIZE_MAX ... #define EV_SSIZE_MAX ... #else @@ -359,7 +359,7 @@ int evutil_make_tcp_listen_socket_deferred(evutil_socket_t sock); int evutil_socket_geterror(evutil_socket_t sock); /** Convert a socket error to a string. */ const char *evutil_socket_error_to_string(int errcode); -#elif defined(_EVENT_IN_DOXYGEN) +#elif defined(EVENT_IN_DOXYGEN_) /** @name Socket error functions