3 # You can use this file with doxygen to create a pseudo-documentation
4 # automatically from source. doxygen-comments are not used very extensively
5 # in i3, mostly for the reason that it clutters the source code and has no
6 # real use (doxygen’s output looks really ugly).
8 # So, if you want to use it, here you go. This is however not a supported
9 # document, and I recommend you have a look at the docs/ folder or at
10 # http://i3wm.org/ for more, real documentation.
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 DOXYFILE_ENCODING = UTF-8
20 OUTPUT_DIRECTORY = pseudo-doc
21 OUTPUT_LANGUAGE = English
22 BRIEF_MEMBER_DESC = YES
24 ALWAYS_DETAILED_SEC = YES
27 JAVADOC_AUTOBRIEF = YES
29 OPTIMIZE_OUTPUT_FOR_C = YES
31 #---------------------------------------------------------------------------
32 # Build related configuration options
33 #---------------------------------------------------------------------------
38 EXTRACT_LOCAL_CLASSES = YES
39 CASE_SENSE_NAMES = YES
40 SHOW_INCLUDE_FILES = YES
41 SORT_MEMBER_DOCS = YES
44 SORT_BY_SCOPE_NAME = NO
48 #---------------------------------------------------------------------------
49 # configuration options related to warning and progress messages
50 #---------------------------------------------------------------------------
54 WARN_IF_UNDOCUMENTED = YES
55 WARN_IF_DOC_ERROR = YES
57 WARN_FORMAT = "$file:$line: $text"
60 #---------------------------------------------------------------------------
61 # configuration options related to the input files
62 #---------------------------------------------------------------------------
65 INPUT_ENCODING = UTF-8
68 #---------------------------------------------------------------------------
69 # configuration options related to source browsing
70 #---------------------------------------------------------------------------
75 STRIP_CODE_COMMENTS = YES
77 REFERENCED_BY_RELATION = YES
78 REFERENCES_RELATION = YES
79 REFERENCES_LINK_SOURCE = YES
81 #---------------------------------------------------------------------------
82 # configuration options related to the alphabetical class index
83 #---------------------------------------------------------------------------
85 ALPHABETICAL_INDEX = NO
86 COLS_IN_ALPHA_INDEX = 5
88 #---------------------------------------------------------------------------
89 # configuration options related to the HTML output
90 #---------------------------------------------------------------------------
94 HTML_FILE_EXTENSION = .html
95 HTML_ALIGN_MEMBERS = YES
96 HTML_DYNAMIC_SECTIONS = NO
103 GENERATE_AUTOGEN_DEF = NO
104 GENERATE_PERLMOD = NO
106 ENABLE_PREPROCESSING = YES
108 EXPAND_ONLY_PREDEF = NO
109 SEARCH_INCLUDES = YES
110 SKIP_FUNCTION_MACROS = YES
112 #---------------------------------------------------------------------------
113 # Configuration::additions related to external references
114 #---------------------------------------------------------------------------
116 PERL_PATH = /usr/bin/perl
118 #---------------------------------------------------------------------------
119 # Configuration options related to the dot tool
120 #---------------------------------------------------------------------------
124 DOT_FONTNAME = FreeSans
127 COLLABORATION_GRAPH = YES
131 INCLUDED_BY_GRAPH = YES
134 GRAPHICAL_HIERARCHY = YES
135 DIRECTORY_GRAPH = YES
136 DOT_IMAGE_FORMAT = png
137 DOT_GRAPH_MAX_NODES = 50
138 MAX_DOT_GRAPH_DEPTH = 0
139 DOT_TRANSPARENT = YES
140 DOT_MULTI_TARGETS = NO
141 GENERATE_LEGEND = YES
144 #---------------------------------------------------------------------------
145 # Configuration::additions related to the search engine
146 #---------------------------------------------------------------------------