bd9de8189b
Thanks to psychoschlumpf for the hint. Having comments in the headers makes it easier to get the big picture when not being interested in the source. The doxygen file extracts as much as it can into HTML files. Please note that this is not official/supported documentation, but rather being nice to people who have to/want to use doxygen (I don’t). Let me paste the header of the doxygen file: You can use this file with doxygen to create a pseudo-documentation automatically from source. doxygen-comments are not used very extensively in i3, mostly for the reason that it clutters the source code and has no real use (doxygen’s output looks really ugly). So, if you want to use it, here you go. This is however not a supported document, and I recommend you have a look at the docs/ folder or at http://i3.zekjur.net/ for more, real documentation.
149 lines
4.9 KiB
Plaintext
149 lines
4.9 KiB
Plaintext
# Doxyfile 1.5.6
|
||
#
|
||
# You can use this file with doxygen to create a pseudo-documentation
|
||
# automatically from source. doxygen-comments are not used very extensively
|
||
# in i3, mostly for the reason that it clutters the source code and has no
|
||
# real use (doxygen’s output looks really ugly).
|
||
#
|
||
# So, if you want to use it, here you go. This is however not a supported
|
||
# document, and I recommend you have a look at the docs/ folder or at
|
||
# http://i3.zekjur.net/ for more, real documentation.
|
||
#
|
||
|
||
#---------------------------------------------------------------------------
|
||
# Project related configuration options
|
||
#---------------------------------------------------------------------------
|
||
|
||
DOXYFILE_ENCODING = UTF-8
|
||
PROJECT_NAME = i3
|
||
PROJECT_NUMBER =
|
||
OUTPUT_DIRECTORY = pseudo-doc
|
||
OUTPUT_LANGUAGE = English
|
||
BRIEF_MEMBER_DESC = YES
|
||
REPEAT_BRIEF = YES
|
||
ALWAYS_DETAILED_SEC = YES
|
||
FULL_PATH_NAMES = YES
|
||
SHORT_NAMES = YES
|
||
JAVADOC_AUTOBRIEF = YES
|
||
TAB_SIZE = 8
|
||
OPTIMIZE_OUTPUT_FOR_C = YES
|
||
|
||
#---------------------------------------------------------------------------
|
||
# Build related configuration options
|
||
#---------------------------------------------------------------------------
|
||
|
||
EXTRACT_ALL = YES
|
||
EXTRACT_PRIVATE = NO
|
||
EXTRACT_STATIC = YES
|
||
EXTRACT_LOCAL_CLASSES = YES
|
||
CASE_SENSE_NAMES = YES
|
||
SHOW_INCLUDE_FILES = YES
|
||
SORT_MEMBER_DOCS = YES
|
||
SORT_BRIEF_DOCS = NO
|
||
SORT_GROUP_NAMES = NO
|
||
SORT_BY_SCOPE_NAME = NO
|
||
SHOW_USED_FILES = YES
|
||
SHOW_FILES = YES
|
||
|
||
#---------------------------------------------------------------------------
|
||
# 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 = src include
|
||
INPUT_ENCODING = UTF-8
|
||
RECURSIVE = NO
|
||
|
||
#---------------------------------------------------------------------------
|
||
# 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
|
||
|
||
#---------------------------------------------------------------------------
|
||
# configuration options related to the alphabetical class index
|
||
#---------------------------------------------------------------------------
|
||
|
||
ALPHABETICAL_INDEX = NO
|
||
COLS_IN_ALPHA_INDEX = 5
|
||
|
||
#---------------------------------------------------------------------------
|
||
# configuration options related to the HTML output
|
||
#---------------------------------------------------------------------------
|
||
|
||
GENERATE_HTML = YES
|
||
HTML_OUTPUT = html
|
||
HTML_FILE_EXTENSION = .html
|
||
HTML_ALIGN_MEMBERS = YES
|
||
HTML_DYNAMIC_SECTIONS = NO
|
||
FORMULA_FONTSIZE = 10
|
||
|
||
GENERATE_LATEX = NO
|
||
GENERATE_RTF = NO
|
||
GENERATE_MAN = NO
|
||
GENERATE_XML = NO
|
||
GENERATE_AUTOGEN_DEF = NO
|
||
GENERATE_PERLMOD = NO
|
||
|
||
ENABLE_PREPROCESSING = YES
|
||
MACRO_EXPANSION = NO
|
||
EXPAND_ONLY_PREDEF = NO
|
||
SEARCH_INCLUDES = YES
|
||
SKIP_FUNCTION_MACROS = YES
|
||
|
||
#---------------------------------------------------------------------------
|
||
# Configuration::additions related to external references
|
||
#---------------------------------------------------------------------------
|
||
|
||
PERL_PATH = /usr/bin/perl
|
||
|
||
#---------------------------------------------------------------------------
|
||
# Configuration options related to the dot tool
|
||
#---------------------------------------------------------------------------
|
||
|
||
CLASS_DIAGRAMS = YES
|
||
HAVE_DOT = YES
|
||
DOT_FONTNAME = FreeSans
|
||
DOT_FONTPATH =
|
||
CLASS_GRAPH = YES
|
||
COLLABORATION_GRAPH = YES
|
||
GROUP_GRAPHS = YES
|
||
UML_LOOK = NO
|
||
INCLUDE_GRAPH = YES
|
||
INCLUDED_BY_GRAPH = YES
|
||
CALL_GRAPH = YES
|
||
CALLER_GRAPH = NO
|
||
GRAPHICAL_HIERARCHY = YES
|
||
DIRECTORY_GRAPH = YES
|
||
DOT_IMAGE_FORMAT = png
|
||
DOT_GRAPH_MAX_NODES = 50
|
||
MAX_DOT_GRAPH_DEPTH = 0
|
||
DOT_TRANSPARENT = YES
|
||
DOT_MULTI_TARGETS = NO
|
||
GENERATE_LEGEND = YES
|
||
DOT_CLEANUP = YES
|
||
|
||
#---------------------------------------------------------------------------
|
||
# Configuration::additions related to the search engine
|
||
#---------------------------------------------------------------------------
|
||
|
||
SEARCHENGINE = NO
|