Inside Bitcoin
Opening the selected file…
Inside Bitcoin
Opening the selected file…
The code behind the network, with room to understand it.
Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.
751WARN_IF_DOC_ERROR = YES753# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that754# are documented, but have no documentation for their parameters or return755# value. If set to NO, doxygen will only warn about wrong or incomplete756# parameter documentation, but not about the absence of documentation.757# The default value is: NO.759WARN_NO_PARAMDOC = NO761# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when762# a warning is encountered.763# The default value is: NO.765WARN_AS_ERROR = NO767# The WARN_FORMAT tag determines the format of the warning messages that doxygen768# can produce. The string should contain the $file, $line, and $text tags, which769# will be replaced by the file and line number from which the warning originated770# and the warning text. Optionally the format may contain $version, which will771# be replaced by the version of the file (if it could be obtained via772# FILE_VERSION_FILTER)773# The default value is: $file:$line: $text.775WARN_FORMAT = "$file:$line: $text"777# The WARN_LOGFILE tag can be used to specify a file to which warning and error778# messages should be written. If left blank the output is written to standard779# error (stderr).781WARN_LOGFILE =783#---------------------------------------------------------------------------784# Configuration options related to the input files785#---------------------------------------------------------------------------787# The INPUT tag is used to specify the files and/or directories that contain788# documented source files. You may enter file names like myfile.cpp or789# directories like /usr/src/myproject. Separate the files or directories with790# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING791# Note: If this tag is empty the current directory is searched.793INPUT = src doc/README_doxygen.md795# This tag can be used to specify the character encoding of the source files796# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses797# libiconv (or the iconv built into libc) for the transcoding. See the libiconv798# documentation (see: http://www.gnu.org/software/libiconv) for the list of799# possible encodings.800# The default value is: UTF-8.802INPUT_ENCODING = UTF-8804# If the value of the INPUT tag contains directories, you can use the805# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and806# *.h) to filter out the source-files in the directories.807#808# Note that for custom extensions or not directly supported extensions you also809# need to set EXTENSION_MAPPING for the extension otherwise the files are not810# read by doxygen.811#812# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,813# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,814# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,815# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,816# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.818FILE_PATTERNS = *.c \819*.cc \820*.cxx \821*.cpp \822*.c++ \823*.d \824*.java \825*.ii \826*.ixx \827*.ipp \828*.i++ \829*.inl \830*.h \831*.hh \832*.hxx \833*.hpp \834*.h++ \835*.idl \836*.odl \837*.cs \838*.php \839*.php3 \840*.inc \841*.m \842*.mm \843*.dox \844*.py \845*.f90 \846*.f \847*.for \848*.vhd \849*.vhdl851# The RECURSIVE tag can be used to specify whether or not subdirectories should852# be searched for input files as well.853# The default value is: NO.855RECURSIVE = YES857# The EXCLUDE tag can be used to specify files and/or directories that should be858# excluded from the INPUT source files. This way you can easily exclude a859# subdirectory from a directory tree whose root is specified with the INPUT tag.860#861# Note that relative paths are relative to the directory from which doxygen is862# run.864EXCLUDE = src/crc32c \865src/leveldb \866src/json868# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or869# directories that are symbolic links (a Unix file system feature) are excluded870# from the input.871# The default value is: NO.873EXCLUDE_SYMLINKS = NO875# If the value of the INPUT tag contains directories, you can use the876# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude877# certain files from those directories.878#879# Note that the wildcards are matched against the file with absolute path, so to880# exclude all test directories for example use the pattern */test/*882EXCLUDE_PATTERNS =884# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names885# (namespaces, classes, functions, etc.) that should be excluded from the886# output. The symbol name can be a fully qualified name, a word, or if the887# wildcard * is used, a substring. Examples: ANamespace, AClass,888# AClass::ANamespace, ANamespace::*Test889#890# Note that the wildcards are matched against the file with absolute path, so to891# exclude all test directories use the pattern */test/*893EXCLUDE_SYMBOLS = boost \894896# The EXAMPLE_PATH tag can be used to specify one or more files or directories897# that contain example code fragments that are included (see the \include898# command).900EXAMPLE_PATH =902# If the value of the EXAMPLE_PATH tag contains directories, you can use the903# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and904# *.h) to filter out the source-files in the directories. If left blank all905# files are included.907EXAMPLE_PATTERNS = *909# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be910# searched for input files to be used with the \include or \dontinclude commands911# irrespective of the value of the RECURSIVE tag.912# The default value is: NO.914EXAMPLE_RECURSIVE = NO916# The IMAGE_PATH tag can be used to specify one or more files or directories917# that contain images that are to be included in the documentation (see the918# \image command).920IMAGE_PATH =922# The INPUT_FILTER tag can be used to specify a program that doxygen should923# invoke to filter for each input file. Doxygen will invoke the filter program924# by executing (via popen()) the command:925#926# <filter> <input-file>927#928# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the929# name of an input file. Doxygen will then use the output that the filter930# program writes to standard output. If FILTER_PATTERNS is specified, this tag931# will be ignored.932#933# Note that the filter must not add or remove lines; it is applied before the934# code is scanned, but not when the output code is generated. If lines are added935# or removed, the anchors will not be placed correctly.936#937# Note that for custom extensions or not directly supported extensions you also938# need to set EXTENSION_MAPPING for the extension otherwise the files are not939# properly processed by doxygen.941INPUT_FILTER =943# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern944# basis. Doxygen will compare the file name with each pattern and apply the945# filter if there is a match. The filters are a list of the form: pattern=filter946# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how947# filters are used. If the FILTER_PATTERNS tag is empty or if none of the948# patterns match the file name, INPUT_FILTER is applied.949#950# Note that for custom extensions or not directly supported extensions you also951# need to set EXTENSION_MAPPING for the extension otherwise the files are not952# properly processed by doxygen.954FILTER_PATTERNS =956# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using957# INPUT_FILTER) will also be used to filter the input files that are used for958# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).959# The default value is: NO.961FILTER_SOURCE_FILES = NO963# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file964# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and965# it is also possible to disable source filtering for a specific pattern using966# *.ext= (so without naming a filter).967# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.969FILTER_SOURCE_PATTERNS =971# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that972# is part of the input, its contents will be placed on the main page973# (index.html). This can be useful if you have a project on for instance GitHub974# and want to reuse the introduction page also for the doxygen output.976USE_MDFILE_AS_MAINPAGE = doc/README_doxygen.md978#---------------------------------------------------------------------------979# Configuration options related to source browsing980#---------------------------------------------------------------------------982# If the SOURCE_BROWSER tag is set to YES then a list of source files will be983# generated. Documented entities will be cross-referenced with these sources.984#985# Note: To get rid of all source code in the generated output, make sure that986# also VERBATIM_HEADERS is set to NO.987# The default value is: NO.989SOURCE_BROWSER = YES991# Setting the INLINE_SOURCES tag to YES will include the body of functions,992# classes and enums directly into the documentation.993# The default value is: NO.995INLINE_SOURCES = NO997# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any998# special comment blocks from generated source code fragments. Normal C, C++ and999# Fortran comments will always remain visible.1000# The default value is: YES.
Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.
Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.