| 1 |
# Doxyfile 1.8.18 |
| 2 |
#--------------------------------------------------------------------------- |
| 3 |
# Project related configuration options |
| 4 |
#--------------------------------------------------------------------------- |
| 5 |
DOXYFILE_ENCODING = UTF-8 |
| 6 |
PROJECT_NAME = NumPy |
| 7 |
PROJECT_NUMBER = |
| 8 |
PROJECT_BRIEF = "NumPy is the fundamental package for scientific computing in Python" |
| 9 |
PROJECT_LOGO = |
| 10 |
OUTPUT_DIRECTORY = @ROOT_DIR/doc/build/doxygen |
| 11 |
CREATE_SUBDIRS = NO |
| 12 |
ALLOW_UNICODE_NAMES = NO |
| 13 |
OUTPUT_LANGUAGE = English |
| 14 |
OUTPUT_TEXT_DIRECTION = None |
| 15 |
BRIEF_MEMBER_DESC = YES |
| 16 |
REPEAT_BRIEF = YES |
| 17 |
ABBREVIATE_BRIEF = "The $name class" \ |
| 18 |
"The $name widget" \ |
| 19 |
"The $name file" \ |
| 20 |
is \ |
| 21 |
provides \ |
| 22 |
specifies \ |
| 23 |
contains \ |
| 24 |
represents \ |
| 25 |
a \ |
| 26 |
an \ |
| 27 |
the |
| 28 |
ALWAYS_DETAILED_SEC = NO |
| 29 |
INLINE_INHERITED_MEMB = NO |
| 30 |
FULL_PATH_NAMES = YES |
| 31 |
STRIP_FROM_PATH = @ROOT_DIR |
| 32 |
STRIP_FROM_INC_PATH = |
| 33 |
SHORT_NAMES = NO |
| 34 |
JAVADOC_AUTOBRIEF = YES |
| 35 |
JAVADOC_BANNER = NO |
| 36 |
QT_AUTOBRIEF = NO |
| 37 |
MULTILINE_CPP_IS_BRIEF = NO |
| 38 |
INHERIT_DOCS = YES |
| 39 |
SEPARATE_MEMBER_PAGES = NO |
| 40 |
TAB_SIZE = 4 |
| 41 |
ALIASES = |
| 42 |
ALIASES += "rst=\verbatim embed:rst:leading-asterisk" |
| 43 |
ALIASES += "endrst=\endverbatim" |
| 44 |
OPTIMIZE_OUTPUT_FOR_C = NO |
| 45 |
OPTIMIZE_OUTPUT_JAVA = NO |
| 46 |
OPTIMIZE_FOR_FORTRAN = NO |
| 47 |
OPTIMIZE_OUTPUT_VHDL = NO |
| 48 |
OPTIMIZE_OUTPUT_SLICE = NO |
| 49 |
EXTENSION_MAPPING = |
| 50 |
MARKDOWN_SUPPORT = YES |
| 51 |
TOC_INCLUDE_HEADINGS = 5 |
| 52 |
AUTOLINK_SUPPORT = YES |
| 53 |
BUILTIN_STL_SUPPORT = NO |
| 54 |
CPP_CLI_SUPPORT = NO |
| 55 |
SIP_SUPPORT = NO |
| 56 |
IDL_PROPERTY_SUPPORT = YES |
| 57 |
DISTRIBUTE_GROUP_DOC = NO |
| 58 |
GROUP_NESTED_COMPOUNDS = NO |
| 59 |
SUBGROUPING = YES |
| 60 |
INLINE_GROUPED_CLASSES = NO |
| 61 |
INLINE_SIMPLE_STRUCTS = NO |
| 62 |
TYPEDEF_HIDES_STRUCT = NO |
| 63 |
LOOKUP_CACHE_SIZE = 0 |
| 64 |
#--------------------------------------------------------------------------- |
| 65 |
# Build related configuration options |
| 66 |
#--------------------------------------------------------------------------- |
| 67 |
EXTRACT_ALL = NO |
| 68 |
EXTRACT_PRIVATE = NO |
| 69 |
EXTRACT_PRIV_VIRTUAL = NO |
| 70 |
EXTRACT_PACKAGE = NO |
| 71 |
EXTRACT_STATIC = NO |
| 72 |
EXTRACT_LOCAL_CLASSES = YES |
| 73 |
EXTRACT_LOCAL_METHODS = NO |
| 74 |
EXTRACT_ANON_NSPACES = NO |
| 75 |
HIDE_UNDOC_MEMBERS = NO |
| 76 |
HIDE_UNDOC_CLASSES = NO |
| 77 |
HIDE_FRIEND_COMPOUNDS = NO |
| 78 |
HIDE_IN_BODY_DOCS = NO |
| 79 |
INTERNAL_DOCS = NO |
| 80 |
CASE_SENSE_NAMES = YES |
| 81 |
HIDE_SCOPE_NAMES = NO |
| 82 |
HIDE_COMPOUND_REFERENCE= NO |
| 83 |
SHOW_INCLUDE_FILES = YES |
| 84 |
SHOW_GROUPED_MEMB_INC = NO |
| 85 |
FORCE_LOCAL_INCLUDES = NO |
| 86 |
INLINE_INFO = YES |
| 87 |
SORT_MEMBER_DOCS = YES |
| 88 |
SORT_BRIEF_DOCS = NO |
| 89 |
SORT_MEMBERS_CTORS_1ST = NO |
| 90 |
SORT_GROUP_NAMES = NO |
| 91 |
SORT_BY_SCOPE_NAME = NO |
| 92 |
STRICT_PROTO_MATCHING = NO |
| 93 |
GENERATE_TODOLIST = YES |
| 94 |
GENERATE_TESTLIST = YES |
| 95 |
GENERATE_BUGLIST = YES |
| 96 |
GENERATE_DEPRECATEDLIST= YES |
| 97 |
ENABLED_SECTIONS = |
| 98 |
MAX_INITIALIZER_LINES = 30 |
| 99 |
SHOW_USED_FILES = YES |
| 100 |
SHOW_FILES = YES |
| 101 |
SHOW_NAMESPACES = YES |
| 102 |
FILE_VERSION_FILTER = |
| 103 |
LAYOUT_FILE = |
| 104 |
CITE_BIB_FILES = |
| 105 |
#--------------------------------------------------------------------------- |
| 106 |
# Configuration options related to warning and progress messages |
| 107 |
#--------------------------------------------------------------------------- |
| 108 |
QUIET = no |
| 109 |
WARNINGS = YES |
| 110 |
WARN_IF_UNDOCUMENTED = YES |
| 111 |
WARN_IF_DOC_ERROR = YES |
| 112 |
WARN_NO_PARAMDOC = NO |
| 113 |
WARN_AS_ERROR = NO |
| 114 |
WARN_FORMAT = "$file:$line: $text" |
| 115 |
WARN_LOGFILE = |
| 116 |
#--------------------------------------------------------------------------- |
| 117 |
# Configuration options related to the input files |
| 118 |
#--------------------------------------------------------------------------- |
| 119 |
INPUT = |
| 120 |
INPUT_ENCODING = UTF-8 |
| 121 |
FILE_PATTERNS = *.h, *.hpp |
| 122 |
RECURSIVE = YES |
| 123 |
EXCLUDE = |
| 124 |
EXCLUDE_SYMLINKS = NO |
| 125 |
EXCLUDE_PATTERNS = |
| 126 |
EXCLUDE_SYMBOLS = |
| 127 |
EXAMPLE_PATH = |
| 128 |
EXAMPLE_PATTERNS = |
| 129 |
EXAMPLE_RECURSIVE = NO |
| 130 |
IMAGE_PATH = |
| 131 |
INPUT_FILTER = |
| 132 |
FILTER_PATTERNS = |
| 133 |
FILTER_SOURCE_FILES = NO |
| 134 |
FILTER_SOURCE_PATTERNS = |
| 135 |
USE_MDFILE_AS_MAINPAGE = |
| 136 |
#--------------------------------------------------------------------------- |
| 137 |
# Configuration options related to source browsing |
| 138 |
#--------------------------------------------------------------------------- |
| 139 |
SOURCE_BROWSER = NO |
| 140 |
INLINE_SOURCES = NO |
| 141 |
STRIP_CODE_COMMENTS = YES |
| 142 |
REFERENCED_BY_RELATION = NO |
| 143 |
REFERENCES_RELATION = NO |
| 144 |
REFERENCES_LINK_SOURCE = YES |
| 145 |
SOURCE_TOOLTIPS = YES |
| 146 |
USE_HTAGS = NO |
| 147 |
VERBATIM_HEADERS = YES |
| 148 |
CLANG_ASSISTED_PARSING = NO |
| 149 |
CLANG_OPTIONS = |
| 150 |
CLANG_DATABASE_PATH = |
| 151 |
#--------------------------------------------------------------------------- |
| 152 |
# Configuration options related to the alphabetical class index |
| 153 |
#--------------------------------------------------------------------------- |
| 154 |
ALPHABETICAL_INDEX = YES |
| 155 |
COLS_IN_ALPHA_INDEX = 5 |
| 156 |
IGNORE_PREFIX = |
| 157 |
#--------------------------------------------------------------------------- |
| 158 |
# Configuration options related to the HTML output |
| 159 |
#--------------------------------------------------------------------------- |
| 160 |
GENERATE_HTML = NO |
| 161 |
HTML_OUTPUT = html |
| 162 |
HTML_FILE_EXTENSION = .html |
| 163 |
HTML_HEADER = |
| 164 |
HTML_FOOTER = |
| 165 |
HTML_STYLESHEET = |
| 166 |
HTML_EXTRA_STYLESHEET = |
| 167 |
HTML_EXTRA_FILES = |
| 168 |
HTML_COLORSTYLE_HUE = 220 |
| 169 |
HTML_COLORSTYLE_SAT = 100 |
| 170 |
HTML_COLORSTYLE_GAMMA = 80 |
| 171 |
HTML_TIMESTAMP = NO |
| 172 |
HTML_DYNAMIC_MENUS = YES |
| 173 |
HTML_DYNAMIC_SECTIONS = NO |
| 174 |
HTML_INDEX_NUM_ENTRIES = 100 |
| 175 |
GENERATE_DOCSET = NO |
| 176 |
DOCSET_FEEDNAME = "Doxygen generated docs" |
| 177 |
DOCSET_BUNDLE_ID = org.doxygen.Project |
| 178 |
DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
| 179 |
DOCSET_PUBLISHER_NAME = Publisher |
| 180 |
GENERATE_HTMLHELP = NO |
| 181 |
CHM_FILE = |
| 182 |
HHC_LOCATION = |
| 183 |
GENERATE_CHI = NO |
| 184 |
CHM_INDEX_ENCODING = |
| 185 |
BINARY_TOC = NO |
| 186 |
TOC_EXPAND = NO |
| 187 |
GENERATE_QHP = NO |
| 188 |
QCH_FILE = |
| 189 |
QHP_NAMESPACE = org.doxygen.Project |
| 190 |
QHP_VIRTUAL_FOLDER = doc |
| 191 |
QHP_CUST_FILTER_NAME = |
| 192 |
QHP_CUST_FILTER_ATTRS = |
| 193 |
QHP_SECT_FILTER_ATTRS = |
| 194 |
QHG_LOCATION = |
| 195 |
GENERATE_ECLIPSEHELP = NO |
| 196 |
ECLIPSE_DOC_ID = org.doxygen.Project |
| 197 |
DISABLE_INDEX = NO |
| 198 |
GENERATE_TREEVIEW = NO |
| 199 |
ENUM_VALUES_PER_LINE = 4 |
| 200 |
TREEVIEW_WIDTH = 250 |
| 201 |
EXT_LINKS_IN_WINDOW = NO |
| 202 |
HTML_FORMULA_FORMAT = png |
| 203 |
FORMULA_FONTSIZE = 10 |
| 204 |
FORMULA_TRANSPARENT = YES |
| 205 |
FORMULA_MACROFILE = |
| 206 |
USE_MATHJAX = NO |
| 207 |
MATHJAX_FORMAT = HTML-CSS |
| 208 |
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@@2 |
| 209 |
MATHJAX_EXTENSIONS = |
| 210 |
MATHJAX_CODEFILE = |
| 211 |
SEARCHENGINE = YES |
| 212 |
SERVER_BASED_SEARCH = NO |
| 213 |
EXTERNAL_SEARCH = NO |
| 214 |
SEARCHENGINE_URL = |
| 215 |
SEARCHDATA_FILE = searchdata.xml |
| 216 |
EXTERNAL_SEARCH_ID = |
| 217 |
EXTRA_SEARCH_MAPPINGS = |
| 218 |
#--------------------------------------------------------------------------- |
| 219 |
# Configuration options related to the LaTeX output |
| 220 |
#--------------------------------------------------------------------------- |
| 221 |
GENERATE_LATEX = NO |
| 222 |
LATEX_OUTPUT = latex |
| 223 |
LATEX_CMD_NAME = |
| 224 |
MAKEINDEX_CMD_NAME = makeindex |
| 225 |
LATEX_MAKEINDEX_CMD = makeindex |
| 226 |
COMPACT_LATEX = NO |
| 227 |
PAPER_TYPE = a4 |
| 228 |
EXTRA_PACKAGES = |
| 229 |
LATEX_HEADER = |
| 230 |
LATEX_FOOTER = |
| 231 |
LATEX_EXTRA_STYLESHEET = |
| 232 |
LATEX_EXTRA_FILES = |
| 233 |
PDF_HYPERLINKS = YES |
| 234 |
USE_PDFLATEX = YES |
| 235 |
LATEX_BATCHMODE = NO |
| 236 |
LATEX_HIDE_INDICES = NO |
| 237 |
LATEX_SOURCE_CODE = NO |
| 238 |
LATEX_BIB_STYLE = plain |
| 239 |
LATEX_TIMESTAMP = NO |
| 240 |
LATEX_EMOJI_DIRECTORY = |
| 241 |
#--------------------------------------------------------------------------- |
| 242 |
# Configuration options related to the RTF output |
| 243 |
#--------------------------------------------------------------------------- |
| 244 |
GENERATE_RTF = NO |
| 245 |
RTF_OUTPUT = rtf |
| 246 |
COMPACT_RTF = NO |
| 247 |
RTF_HYPERLINKS = NO |
| 248 |
RTF_STYLESHEET_FILE = |
| 249 |
RTF_EXTENSIONS_FILE = |
| 250 |
RTF_SOURCE_CODE = NO |
| 251 |
#--------------------------------------------------------------------------- |
| 252 |
# Configuration options related to the man page output |
| 253 |
#--------------------------------------------------------------------------- |
| 254 |
GENERATE_MAN = NO |
| 255 |
MAN_OUTPUT = man |
| 256 |
MAN_EXTENSION = .3 |
| 257 |
MAN_SUBDIR = |
| 258 |
MAN_LINKS = NO |
| 259 |
#--------------------------------------------------------------------------- |
| 260 |
# Configuration options related to the XML output |
| 261 |
#--------------------------------------------------------------------------- |
| 262 |
GENERATE_XML = YES |
| 263 |
XML_OUTPUT = xml |
| 264 |
XML_PROGRAMLISTING = YES |
| 265 |
XML_NS_MEMB_FILE_SCOPE = NO |
| 266 |
#--------------------------------------------------------------------------- |
| 267 |
# Configuration options related to the DOCBOOK output |
| 268 |
#--------------------------------------------------------------------------- |
| 269 |
GENERATE_DOCBOOK = NO |
| 270 |
DOCBOOK_OUTPUT = docbook |
| 271 |
DOCBOOK_PROGRAMLISTING = NO |
| 272 |
#--------------------------------------------------------------------------- |
| 273 |
# Configuration options for the AutoGen Definitions output |
| 274 |
#--------------------------------------------------------------------------- |
| 275 |
GENERATE_AUTOGEN_DEF = NO |
| 276 |
#--------------------------------------------------------------------------- |
| 277 |
# Configuration options related to the Perl module output |
| 278 |
#--------------------------------------------------------------------------- |
| 279 |
GENERATE_PERLMOD = NO |
| 280 |
PERLMOD_LATEX = NO |
| 281 |
PERLMOD_PRETTY = YES |
| 282 |
PERLMOD_MAKEVAR_PREFIX = |
| 283 |
#--------------------------------------------------------------------------- |
| 284 |
# Configuration options related to the preprocessor |
| 285 |
#--------------------------------------------------------------------------- |
| 286 |
ENABLE_PREPROCESSING = YES |
| 287 |
MACRO_EXPANSION = YES |
| 288 |
EXPAND_ONLY_PREDEF = NO |
| 289 |
SEARCH_INCLUDES = YES |
| 290 |
INCLUDE_PATH = |
| 291 |
INCLUDE_FILE_PATTERNS = |
| 292 |
PREDEFINED = |
| 293 |
EXPAND_AS_DEFINED = |
| 294 |
SKIP_FUNCTION_MACROS = YES |
| 295 |
#--------------------------------------------------------------------------- |
| 296 |
# Configuration options related to external references |
| 297 |
#--------------------------------------------------------------------------- |
| 298 |
TAGFILES = |
| 299 |
GENERATE_TAGFILE = |
| 300 |
ALLEXTERNALS = NO |
| 301 |
EXTERNAL_GROUPS = YES |
| 302 |
EXTERNAL_PAGES = YES |
| 303 |
#--------------------------------------------------------------------------- |
| 304 |
# Configuration options related to the dot tool |
| 305 |
#--------------------------------------------------------------------------- |
| 306 |
CLASS_DIAGRAMS = YES |
| 307 |
DIA_PATH = |
| 308 |
HIDE_UNDOC_RELATIONS = YES |
| 309 |
HAVE_DOT = NO |
| 310 |
DOT_NUM_THREADS = 0 |
| 311 |
DOT_FONTNAME = Helvetica |
| 312 |
DOT_FONTSIZE = 10 |
| 313 |
DOT_FONTPATH = |
| 314 |
CLASS_GRAPH = YES |
| 315 |
COLLABORATION_GRAPH = YES |
| 316 |
GROUP_GRAPHS = YES |
| 317 |
UML_LOOK = NO |
| 318 |
UML_LIMIT_NUM_FIELDS = 10 |
| 319 |
TEMPLATE_RELATIONS = NO |
| 320 |
INCLUDE_GRAPH = YES |
| 321 |
INCLUDED_BY_GRAPH = YES |
| 322 |
CALL_GRAPH = NO |
| 323 |
CALLER_GRAPH = NO |
| 324 |
GRAPHICAL_HIERARCHY = YES |
| 325 |
DIRECTORY_GRAPH = YES |
| 326 |
DOT_IMAGE_FORMAT = png |
| 327 |
INTERACTIVE_SVG = NO |
| 328 |
DOT_PATH = |
| 329 |
DOTFILE_DIRS = |
| 330 |
MSCFILE_DIRS = |
| 331 |
DIAFILE_DIRS = |
| 332 |
PLANTUML_JAR_PATH = |
| 333 |
PLANTUML_CFG_FILE = |
| 334 |
PLANTUML_INCLUDE_PATH = |
| 335 |
DOT_GRAPH_MAX_NODES = 50 |
| 336 |
MAX_DOT_GRAPH_DEPTH = 0 |
| 337 |
DOT_TRANSPARENT = NO |
| 338 |
DOT_MULTI_TARGETS = NO |
| 339 |
GENERATE_LEGEND = YES |
| 340 |
DOT_CLEANUP = YES |