diff options
| author | 卜部昌平 <shyouhei@ruby-lang.org> | 2019-12-21 17:14:20 +0900 |
|---|---|---|
| committer | 卜部昌平 <shyouhei@ruby-lang.org> | 2020-02-06 11:46:51 +0900 |
| commit | 3b69552a5ca1fb814fd7279edd970be458a907f2 (patch) | |
| tree | e65821902a7d2acb407719d1778e7e45f75513e2 /template/Doxyfile.tmpl | |
| parent | 7c20a2c83cc50ef33d1095be8806ddacb0f8b321 (diff) | |
add predefined macros for Doxygen
Predefined macros are practices not very well recommended, but can be
better than having no documents at all. Without those predefined
macros, Doxygen confused for instace PUREFUNC(int foo()) to be a
declaration of PUREFUNC, not foo.
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/2885
Diffstat (limited to 'template/Doxyfile.tmpl')
| -rw-r--r-- | template/Doxyfile.tmpl | 46 |
1 files changed, 43 insertions, 3 deletions
diff --git a/template/Doxyfile.tmpl b/template/Doxyfile.tmpl index a16e43bc65..59c184b6be 100644 --- a/template/Doxyfile.tmpl +++ b/template/Doxyfile.tmpl @@ -214,12 +214,52 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO -EXPAND_ONLY_PREDEF = NO +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES SEARCH_INCLUDES = YES INCLUDE_PATH = <%=srcdir%> <%=srcdir%>/include INCLUDE_FILE_PATTERNS = -PREDEFINED = +PREDEFINED = \ + ALWAYS_INLINE(_)=_ \ + COLDFUNC= \ + CONSTFUNC(_)=_ \ + DEPRECATED(_)=_ \ + DEPRECATED_BY(__,_)=_ \ + DEPRECATED_TYPE(__,_)=_ \ + ERRORFUNC(__,_)=_ \ + MJIT_FUNC_EXPORTED= \ + MJIT_STATIC=extern \ + MJIT_SYMBOL_EXPORT_BEGIN= \ + MJIT_SYMBOL_EXPORT_END= \ + NOINLINE(_)=_ \ + NORETURN(_)=_ \ + PRINTF_ARGS(_,__,___)=_ \ + PUREFUNC(_)=_ \ + RUBY_EXTERN=extern \ + RUBY_FUNC_EXPORTED= \ + RUBY_FUNC_NONNULL(__,_)=_ \ + RUBY_SYMBOL_EXPORT_BEGIN= \ + RUBY_SYMBOL_EXPORT_END= \ + WARNINGFUNC(__,_)=_ \ + _MSC_VER=1924 \ + __DOXYGEN__ \ + __GNUC_MINOR__=0 \ + __GNUC_PATCHLEVEL__=0 \ + __GNUC__=10 \ + __STDC_VERSION__=201710L \ + __clang__=10 \ + __clang_major__=10 \ + __clang_minor__=0 \ + __clang_patchlevel__=0 \ + __cplusplus=201704L \ + __has_attribute(_)=0 \ + __has_builtin(_)=0 \ + __has_c_attribute(_)=0 \ + __has_cpp_attribute(_)=0 \ + __has_declspec_attribute(_)=0 \ + __has_extension(_)=0 \ + __has_feature(_)=0 \ + __has_warning(_)=0 EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- |