Merged revisions 157104 via svnmerge from
authorKevin P. Fleming <kpfleming@digium.com>
Sat, 15 Nov 2008 18:25:01 +0000 (18:25 +0000)
committerKevin P. Fleming <kpfleming@digium.com>
Sat, 15 Nov 2008 18:25:01 +0000 (18:25 +0000)
https://origsvn.digium.com/svn/asterisk/branches/1.4

........
  r157104 | kpfleming | 2008-11-15 19:00:32 +0100 (Sat, 15 Nov 2008) | 13 lines

  major update to doxygen configuration file:

  1) update to doxygen 1.5.x style file, as used in trunk

  2) tell doxygen where are header files are, so include-file processing can be done

  3) make all macros that are used to define variables/functions be expanded, so that doxygen will properly document the resulting variable/function

  4) make all macros that are used to provide the contents of a variable (structure) be expanded, so that doxygen will be able to document the resulting fields

  5) suppress compiler attributes (__attribute__(xxx)) from being seen by doxygen, so it will properly match up function definition and usage (for an example of th effect of this, look at the doxygen docs for ast_log() from before and afte this commit)
........

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@157105 65c4cc65-6c06-0410-ace0-fbb531ad65f3

contrib/asterisk-ng-doxygen

index f1259ee..ef96f0d 100644 (file)
@@ -1029,7 +1029,7 @@ SEARCH_INCLUDES        = YES
 # contain include files that are not input files but should be processed by 
 # the preprocessor.
 
-INCLUDE_PATH           = 
+INCLUDE_PATH           = include/ include/asterisk/
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
 # patterns (like *.h and *.hpp) to filter out the header-files in the 
@@ -1046,14 +1046,59 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator 
 # instead of the = operator.
 
-PREDEFINED             = __GNUC__
+PREDEFINED             = \
+                       __GNUC__ \
+                       __attribute__(x)=
 
 # 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. 
 # The macro definition that is found in the sources will be used. 
 # Use the PREDEFINED tag if you want to use a different macro definition.
 
-EXPAND_AS_DEFINED      = 
+EXPAND_AS_DEFINED      = \
+                       AST_INLINE_API \
+                       AST_DECLARE_STRING_FIELDS \
+                       AST_STRING_FIELD \
+                       AST_THREADSTORAGE \
+                       AST_THREADSTORAGE_CUSTOM \
+                       AST_MODULE_INFO \
+                       AST_MODULE_INFO_STANDARD \
+                       __AST_MUTEX_DEFINE \
+                       AST_MUTEX_DEFINE_STATIC \
+                       AST_MUTEX_DEFINE_STATIC_NOTRACKING \
+                       __AST_RWLOCK_DEFINE \
+                       AST_RWLOCK_DEFINE_STATIC \
+                       AST_LIST_HEAD \
+                       AST_RWLIST_HEAD \
+                       AST_LIST_HEAD_NOLOCK \
+                       AST_LIST_HEAD_STATIC \
+                       AST_RWLIST_HEAD_STATIC \
+                       AST_LIST_HEAD_NOLOCK_STATIC \
+                       AST_LIST_ENTRY \
+                       AST_RWLIST_ENTRY \
+                       __ASTOBJ_HASH \
+                       ASTOBJ_COMPONENTS_NOLOCK_FULL \
+                       ASTOBJ_COMPONENTS_NOLOCK \
+                       ASTOBJ_COMPONENTS_FULL \
+                       ASTOBJ_COMPONENTS \
+                       AST_IVR_DECLARE_MENU \
+                       AST_DECLARE_APP_ARGS \
+                       AST_DEFINE_APP_ARGS_TYPE \
+                       AST_APP_ARG \
+                       BEGIN_OPTIONS \
+                       END_OPTIONS \
+                       AST_APP_OPTIONS \
+                       AST_APP_OPTION \
+                       AST_APP_OPTION_ARG \
+                       AST_DLLIST_HEAD \
+                       AST_DLLIST_HEAD_STATIC \
+                       AST_DLLIST_HEAD_NOLOCK \
+                       AST_DLLIST_HEAD_NOLOCK_STATIC \
+                       AST_RWDLLIST_HEAD \
+                       AST_RWDLLIST_HEAD_STATIC \
+                       AST_DLLIST_ENTRY \
+                       AST_RWDLLIST_ENTRY \
+                       AST_CLI_DEFINE
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
 # doxygen's preprocessor will remove all function-like macros that are alone