sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-27 03:21:53 +03:00
Code
13ed08cd2a
samba-mirror/source/Doxyfile

177 lines
6.5 KiB
Plaintext
Raw Normal View History

Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
# Doxyfile 0.1
#---------------------------------------------------------------------------
# General configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = Samba
PROJECT_NUMBER = HEAD
Merge from HEAD to allow automatic Doxygen generation.
0001-01-01 02:30:17 +02:30
# NOTE: By default, Doxygen writes into the dox/ subdirectory of the
# invocation directory. If you want to put it somewhere else, for
# example, to write straight into a webserver directory, then override
# this variable in a configuration concatenated to this one: Doxygen
# doesn't mind variables being redefined.
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
OUTPUT_DIRECTORY = dox
Merge from HEAD to allow automatic Doxygen generation.
0001-01-01 02:30:17 +02:30
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
OUTPUT_LANGUAGE = English
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ALWAYS_DETAILED_SEC = NO
Remove reference to "mainpage.dox" and CodingStandards, which have been removed. Put subdirectory names in file list, so we get lib/util_chr.c, not just util_chr.c.
0001-01-01 02:30:17 +02:30
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = $(PWD)/
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
INTERNAL_DOCS = YES
CLASS_DIAGRAMS = YES
SOURCE_BROWSER = YES
INLINE_SOURCES = YES
Leave doc comments in code listings for the web.
0001-01-01 02:30:17 +02:30
STRIP_CODE_COMMENTS = NO
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
CASE_SENSE_NAMES = YES
SHORT_NAMES = NO
HIDE_SCOPE_NAMES = YES
VERBATIM_HEADERS = YES
SHOW_INCLUDE_FILES = YES
JAVADOC_AUTOBRIEF = YES
INHERIT_DOCS = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = NO
DISTRIBUTE_GROUP_DOC = NO
TAB_SIZE = 8
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
ALIASES =
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
OPTIMIZE_OUTPUT_FOR_C = YES
SHOW_USED_FILES = YES
Make CodingSuggestions show up in the Doxygen pages.
0001-01-01 02:30:17 +02:30
REFERENCED_BY_RELATION = YES
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
Merge from HEAD to allow automatic Doxygen generation.
0001-01-01 02:30:17 +02:30
QUIET = YES
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
WARNINGS = NO
WARN_IF_UNDOCUMENTED = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
Remove reference to "mainpage.dox" and CodingStandards, which have been removed. Put subdirectory names in file list, so we get lib/util_chr.c, not just util_chr.c.
0001-01-01 02:30:17 +02:30
INPUT = .
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
FILE_PATTERNS = *.c \
*.h \
*.idl
RECURSIVE = YES
EXCLUDE = include/includes.h \
include/proto.h
EXCLUDE_PATTERNS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
IMAGE_PATH =
INPUT_FILTER =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 1
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
Merge from HEAD to allow automatic Doxygen generation.
0001-01-01 02:30:17 +02:30
HTML_OUTPUT = .
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
Fixed typo.
0001-01-01 02:30:17 +02:30
HTML_ALIGN_MEMBERS = YES
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
GENERATE_HTMLHELP = NO
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 3
Don't include the treeview -- for Samba it is too big and can lock up browsers.
0001-01-01 02:30:17 +02:30
GENERATE_TREEVIEW = NO
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = YES
#---------------------------------------------------------------------------
# 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
#---------------------------------------------------------------------------
syncing up with HEAD. Seems to be a lot of differences creeping in (i ignored the new SAMBA stuff, but the rest of this looks like it should have been merged already).
0001-01-01 02:30:17 +02:30
# configuration options related to the preprocessor
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
#---------------------------------------------------------------------------
Make CodingSuggestions show up in the Doxygen pages.
0001-01-01 02:30:17 +02:30
ENABLE_PREPROCESSING = NO
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
syncing up with HEAD. Seems to be a lot of differences creeping in (i ignored the new SAMBA stuff, but the rest of this looks like it should have been merged already).
0001-01-01 02:30:17 +02:30
# configuration::additions related to external references
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
syncing up with HEAD. Seems to be a lot of differences creeping in (i ignored the new SAMBA stuff, but the rest of this looks like it should have been merged already).
0001-01-01 02:30:17 +02:30
# configuration options related to the dot tool
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
#---------------------------------------------------------------------------
Merge from HEAD to allow automatic Doxygen generation.
0001-01-01 02:30:17 +02:30
HAVE_DOT = NO
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
TEMPLATE_RELATIONS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
GRAPHICAL_HIERARCHY = YES
DOT_PATH =
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 1024
MAX_DOT_GRAPH_HEIGHT = 1024
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
syncing up with HEAD. Seems to be a lot of differences creeping in (i ignored the new SAMBA stuff, but the rest of this looks like it should have been merged already).
0001-01-01 02:30:17 +02:30
# configuration::additions related to the search engine
Configuration file to run the Doxygen API documentation tool. A few files already have Doxygen markup. Instructions on inserting tags into new code can be found at http://doxygen.org/. Output is (currently) at http://samba.org/~mbp/samba-dox/
0001-01-01 02:30:17 +02:30
#---------------------------------------------------------------------------
SEARCHENGINE = NO
CGI_NAME = search.cgi
CGI_URL =
DOC_URL =
DOC_ABSPATH =
BIN_ABSPATH = /usr/local/bin/
EXT_DOC_PATHS =
Copy Permalink