mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
3b69552a5c
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.
305 lines
11 KiB
Cheetah
305 lines
11 KiB
Cheetah
# Doxyfile 1.5.7
|
|
<%
|
|
srcdir = miniruby = nil
|
|
opt = OptionParser.new do |o|
|
|
o.on('--srcdir=SRCDIR') {|v| srcdir = v}
|
|
o.on('--miniruby=MINIRUBY') {|v| miniruby = v}
|
|
o.order!(ARGV)
|
|
end
|
|
srcdir ||= File.dirname(File.dirname(__FILE__))
|
|
load 'rbconfig.rb'
|
|
unless miniruby
|
|
miniruby = './miniruby$(EXEEXT) -I$(srcdir)/lib -I$(EXTOUT)/common -I./-'
|
|
RbConfig.expand(miniruby, RbConfig::CONFIG.merge("srcdir"=>srcdir))
|
|
end
|
|
dot = RbConfig::CONFIG['DOT'] || ""
|
|
have_dot = dot.empty? ? "NO" : "YES"
|
|
%>
|
|
#---------------------------------------------------------------------------
|
|
# Project related configuration options
|
|
#---------------------------------------------------------------------------
|
|
PROJECT_NAME = Ruby
|
|
PROJECT_NUMBER = <%=RUBY_VERSION%><%= RUBY_PATCHLEVEL < 0 ? 'dev' : "p#{RUBY_PATCHLEVEL}" %> (<%=RUBY_RELEASE_DATE%> revision <%=RUBY_REVISION%>)
|
|
STRIP_FROM_PATH = <%=srcdir%>
|
|
FILE_VERSION_FILTER = "<%=miniruby%> <%=srcdir%>/tool/file2lastrev.rb -q --srcdir=<%=srcdir%>"
|
|
INPUT = <%=srcdir%> .
|
|
INPUT_FILTER = "<%=miniruby%> <%=srcdir%>/tool/strip-rdoc.rb"
|
|
|
|
DOXYFILE_ENCODING = UTF-8
|
|
OUTPUT_DIRECTORY = doc/capi
|
|
CREATE_SUBDIRS = YES
|
|
OUTPUT_LANGUAGE = English
|
|
BRIEF_MEMBER_DESC = YES
|
|
REPEAT_BRIEF = YES
|
|
ABBREVIATE_BRIEF =
|
|
ALWAYS_DETAILED_SEC = YES
|
|
INLINE_INHERITED_MEMB = NO
|
|
FULL_PATH_NAMES = YES
|
|
STRIP_FROM_INC_PATH =
|
|
SHORT_NAMES = NO
|
|
JAVADOC_AUTOBRIEF = YES
|
|
QT_AUTOBRIEF = YES
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
|
INHERIT_DOCS = YES
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
TAB_SIZE = 8
|
|
ALIASES =
|
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
|
OPTIMIZE_OUTPUT_JAVA = NO
|
|
OPTIMIZE_FOR_FORTRAN = NO
|
|
OPTIMIZE_OUTPUT_VHDL = NO
|
|
BUILTIN_STL_SUPPORT = NO
|
|
CPP_CLI_SUPPORT = NO
|
|
SIP_SUPPORT = NO
|
|
IDL_PROPERTY_SUPPORT = NO
|
|
DISTRIBUTE_GROUP_DOC = NO
|
|
SUBGROUPING = YES
|
|
TYPEDEF_HIDES_STRUCT = NO
|
|
SYMBOL_CACHE_SIZE = 0
|
|
#---------------------------------------------------------------------------
|
|
# Build related configuration options
|
|
#---------------------------------------------------------------------------
|
|
EXTRACT_ALL = YES
|
|
EXTRACT_PRIVATE = NO
|
|
EXTRACT_STATIC = NO
|
|
EXTRACT_LOCAL_CLASSES = YES
|
|
EXTRACT_LOCAL_METHODS = NO
|
|
EXTRACT_ANON_NSPACES = NO
|
|
HIDE_UNDOC_MEMBERS = NO
|
|
HIDE_UNDOC_CLASSES = NO
|
|
HIDE_FRIEND_COMPOUNDS = NO
|
|
HIDE_IN_BODY_DOCS = YES
|
|
INTERNAL_DOCS = NO
|
|
CASE_SENSE_NAMES = NO
|
|
HIDE_SCOPE_NAMES = NO
|
|
SHOW_INCLUDE_FILES = YES
|
|
INLINE_INFO = YES
|
|
SORT_MEMBER_DOCS = YES
|
|
SORT_BRIEF_DOCS = NO
|
|
SORT_GROUP_NAMES = NO
|
|
SORT_BY_SCOPE_NAME = NO
|
|
GENERATE_TODOLIST = YES
|
|
GENERATE_TESTLIST = YES
|
|
GENERATE_BUGLIST = YES
|
|
GENERATE_DEPRECATEDLIST= YES
|
|
ENABLED_SECTIONS =
|
|
MAX_INITIALIZER_LINES = 30
|
|
SHOW_USED_FILES = YES
|
|
SHOW_FILES = YES
|
|
SHOW_NAMESPACES = YES
|
|
LAYOUT_FILE =
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to warning and progress messages
|
|
#---------------------------------------------------------------------------
|
|
QUIET = NO
|
|
WARNINGS = YES
|
|
WARN_IF_UNDOCUMENTED = YES
|
|
WARN_IF_DOC_ERROR = YES
|
|
WARN_NO_PARAMDOC = NO
|
|
WARN_FORMAT = "$file:$line: $text"
|
|
WARN_LOGFILE =
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the input files
|
|
#---------------------------------------------------------------------------
|
|
INPUT_ENCODING = UTF-8
|
|
FILE_PATTERNS = *.c *.h *.hpp *.y *.def
|
|
RECURSIVE = YES
|
|
EXCLUDE = <%=srcdir%>/ext/dl/callback <%=srcdir%>/ccan <%=srcdir%>/ext/psych/yaml
|
|
EXCLUDE_SYMLINKS = YES
|
|
EXCLUDE_PATTERNS = *.src doc enc build */ext/-test-/* tmp test yarvtest lib bootstraptest spec .ext .git .svn extconf.h *prelude.c encdb.h transdb.h insns.def rb_mjit_header.h
|
|
EXCLUDE_SYMBOLS =
|
|
EXAMPLE_PATH =
|
|
EXAMPLE_PATTERNS =
|
|
EXAMPLE_RECURSIVE = NO
|
|
IMAGE_PATH = <%=srcdir%>/doc/images
|
|
FILTER_PATTERNS =
|
|
FILTER_SOURCE_FILES = YES
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to source browsing
|
|
#---------------------------------------------------------------------------
|
|
SOURCE_BROWSER = YES
|
|
INLINE_SOURCES = NO
|
|
STRIP_CODE_COMMENTS = YES
|
|
REFERENCED_BY_RELATION = YES
|
|
REFERENCES_RELATION = YES
|
|
REFERENCES_LINK_SOURCE = YES
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = YES
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the alphabetical class index
|
|
#---------------------------------------------------------------------------
|
|
COLS_IN_ALPHA_INDEX = 5
|
|
IGNORE_PREFIX =
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the HTML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_HTML = YES
|
|
HTML_OUTPUT = html
|
|
HTML_FILE_EXTENSION = .html
|
|
HTML_HEADER =
|
|
HTML_FOOTER =
|
|
HTML_STYLESHEET =
|
|
HTML_DYNAMIC_SECTIONS = NO
|
|
GENERATE_DOCSET = NO
|
|
DOCSET_FEEDNAME = "Doxygen generated docs"
|
|
DOCSET_BUNDLE_ID = org.doxygen.Project
|
|
GENERATE_HTMLHELP = NO
|
|
CHM_FILE =
|
|
HHC_LOCATION =
|
|
GENERATE_CHI = NO
|
|
CHM_INDEX_ENCODING =
|
|
BINARY_TOC = NO
|
|
TOC_EXPAND = NO
|
|
GENERATE_QHP = NO
|
|
QCH_FILE =
|
|
QHP_NAMESPACE = org.doxygen.Project
|
|
QHP_VIRTUAL_FOLDER = doc
|
|
QHG_LOCATION =
|
|
DISABLE_INDEX = NO
|
|
ENUM_VALUES_PER_LINE = 4
|
|
GENERATE_TREEVIEW = NO
|
|
TREEVIEW_WIDTH = 250
|
|
FORMULA_FONTSIZE = 10
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the LaTeX output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_LATEX = NO
|
|
LATEX_OUTPUT = latex
|
|
LATEX_CMD_NAME = latex
|
|
MAKEINDEX_CMD_NAME = makeindex
|
|
COMPACT_LATEX = NO
|
|
PAPER_TYPE = a4wide
|
|
EXTRA_PACKAGES =
|
|
LATEX_HEADER =
|
|
PDF_HYPERLINKS = YES
|
|
USE_PDFLATEX = YES
|
|
LATEX_BATCHMODE = NO
|
|
LATEX_HIDE_INDICES = NO
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the RTF output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_RTF = NO
|
|
RTF_OUTPUT = rtf
|
|
COMPACT_RTF = NO
|
|
RTF_HYPERLINKS = NO
|
|
RTF_STYLESHEET_FILE =
|
|
RTF_EXTENSIONS_FILE =
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the man page output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_MAN = NO
|
|
MAN_OUTPUT = man
|
|
MAN_EXTENSION = .3
|
|
MAN_LINKS = NO
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the XML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_XML = NO
|
|
XML_OUTPUT = xml
|
|
XML_SCHEMA =
|
|
XML_DTD =
|
|
XML_PROGRAMLISTING = YES
|
|
#---------------------------------------------------------------------------
|
|
# configuration options for the AutoGen Definitions output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_AUTOGEN_DEF = NO
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the Perl module output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_PERLMOD = NO
|
|
PERLMOD_LATEX = NO
|
|
PERLMOD_PRETTY = YES
|
|
PERLMOD_MAKEVAR_PREFIX =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the preprocessor
|
|
#---------------------------------------------------------------------------
|
|
ENABLE_PREPROCESSING = YES
|
|
MACRO_EXPANSION = YES
|
|
EXPAND_ONLY_PREDEF = YES
|
|
SEARCH_INCLUDES = YES
|
|
INCLUDE_PATH = <%=srcdir%> <%=srcdir%>/include
|
|
INCLUDE_FILE_PATTERNS =
|
|
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
|
|
#---------------------------------------------------------------------------
|
|
# Configuration::additions related to external references
|
|
#---------------------------------------------------------------------------
|
|
TAGFILES =
|
|
GENERATE_TAGFILE =
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = YES
|
|
PERL_PATH = /usr/bin/perl
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the dot tool
|
|
#---------------------------------------------------------------------------
|
|
CLASS_DIAGRAMS = NO
|
|
MSCGEN_PATH =
|
|
HIDE_UNDOC_RELATIONS = YES
|
|
HAVE_DOT = <%= have_dot %>
|
|
DOT_FONTNAME = FreeSans
|
|
DOT_FONTPATH =
|
|
CLASS_GRAPH = NO
|
|
COLLABORATION_GRAPH = NO
|
|
GROUP_GRAPHS = YES
|
|
UML_LOOK = NO
|
|
TEMPLATE_RELATIONS = NO
|
|
INCLUDE_GRAPH = YES
|
|
INCLUDED_BY_GRAPH = YES
|
|
CALL_GRAPH = NO
|
|
CALLER_GRAPH = NO
|
|
GRAPHICAL_HIERARCHY = NO
|
|
DIRECTORY_GRAPH = NO
|
|
DOT_IMAGE_FORMAT = png
|
|
DOT_PATH =
|
|
DOTFILE_DIRS =
|
|
DOT_GRAPH_MAX_NODES = 50
|
|
MAX_DOT_GRAPH_DEPTH = 0
|
|
DOT_TRANSPARENT = NO
|
|
DOT_MULTI_TARGETS = NO
|
|
GENERATE_LEGEND = YES
|
|
DOT_CLEANUP = YES
|
|
#---------------------------------------------------------------------------
|
|
# Configuration::additions related to the search engine
|
|
#---------------------------------------------------------------------------
|
|
SEARCHENGINE = NO
|