]> git.sur5r.net Git - i3/i3/blob - pseudo-doc.doxygen
Bugfix: use restore_conn, not conn
[i3/i3] / pseudo-doc.doxygen
1 # Doxyfile 1.5.6
2 #
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).
7 #
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 # https://i3wm.org/ for more, real documentation.
11 #
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 DOXYFILE_ENCODING      = UTF-8
18 PROJECT_NAME           = i3
19 PROJECT_NUMBER         = 
20 OUTPUT_DIRECTORY       = pseudo-doc
21 OUTPUT_LANGUAGE        = English
22 BRIEF_MEMBER_DESC      = YES
23 REPEAT_BRIEF           = YES
24 ALWAYS_DETAILED_SEC    = YES
25 FULL_PATH_NAMES        = YES
26 SHORT_NAMES            = YES
27 JAVADOC_AUTOBRIEF      = YES
28 TAB_SIZE               = 8
29 OPTIMIZE_OUTPUT_FOR_C  = YES
30
31 #---------------------------------------------------------------------------
32 # Build related configuration options
33 #---------------------------------------------------------------------------
34
35 EXTRACT_ALL            = YES
36 EXTRACT_PRIVATE        = NO
37 EXTRACT_STATIC         = YES
38 EXTRACT_LOCAL_CLASSES  = YES
39 CASE_SENSE_NAMES       = YES
40 SHOW_INCLUDE_FILES     = YES
41 SORT_MEMBER_DOCS       = YES
42 SORT_BRIEF_DOCS        = NO
43 SORT_GROUP_NAMES       = NO
44 SORT_BY_SCOPE_NAME     = NO
45 SHOW_USED_FILES        = YES
46 SHOW_FILES             = YES
47
48 #---------------------------------------------------------------------------
49 # configuration options related to warning and progress messages
50 #---------------------------------------------------------------------------
51
52 QUIET                  = NO
53 WARNINGS               = YES
54 WARN_IF_UNDOCUMENTED   = YES
55 WARN_IF_DOC_ERROR      = YES
56 WARN_NO_PARAMDOC       = NO
57 WARN_FORMAT            = "$file:$line: $text"
58 WARN_LOGFILE           = 
59
60 #---------------------------------------------------------------------------
61 # configuration options related to the input files
62 #---------------------------------------------------------------------------
63
64 INPUT                  = src include
65 INPUT_ENCODING         = UTF-8
66 RECURSIVE              = NO
67
68 #---------------------------------------------------------------------------
69 # configuration options related to source browsing
70 #---------------------------------------------------------------------------
71
72 SOURCE_BROWSER         = YES
73 INLINE_SOURCES         = NO
74
75 STRIP_CODE_COMMENTS    = YES
76
77 REFERENCED_BY_RELATION = YES
78 REFERENCES_RELATION    = YES
79 REFERENCES_LINK_SOURCE = YES
80
81 #---------------------------------------------------------------------------
82 # configuration options related to the alphabetical class index
83 #---------------------------------------------------------------------------
84
85 ALPHABETICAL_INDEX     = NO
86 COLS_IN_ALPHA_INDEX    = 5
87
88 #---------------------------------------------------------------------------
89 # configuration options related to the HTML output
90 #---------------------------------------------------------------------------
91
92 GENERATE_HTML          = YES
93 HTML_OUTPUT            = html
94 HTML_FILE_EXTENSION    = .html
95 HTML_ALIGN_MEMBERS     = YES
96 HTML_DYNAMIC_SECTIONS  = NO
97 FORMULA_FONTSIZE       = 10
98
99 GENERATE_LATEX         = NO
100 GENERATE_RTF           = NO
101 GENERATE_MAN           = NO
102 GENERATE_XML           = NO
103 GENERATE_AUTOGEN_DEF   = NO
104 GENERATE_PERLMOD       = NO
105
106 ENABLE_PREPROCESSING   = YES
107 MACRO_EXPANSION        = NO
108 EXPAND_ONLY_PREDEF     = NO
109 SEARCH_INCLUDES        = YES
110 SKIP_FUNCTION_MACROS   = YES
111
112 #---------------------------------------------------------------------------
113 # Configuration::additions related to external references   
114 #---------------------------------------------------------------------------
115
116 PERL_PATH              = /usr/bin/perl
117
118 #---------------------------------------------------------------------------
119 # Configuration options related to the dot tool   
120 #---------------------------------------------------------------------------
121
122 CLASS_DIAGRAMS         = YES
123 HAVE_DOT               = YES
124 DOT_FONTNAME           = FreeSans
125 DOT_FONTPATH           = 
126 CLASS_GRAPH            = YES
127 COLLABORATION_GRAPH    = YES
128 GROUP_GRAPHS           = YES
129 UML_LOOK               = NO
130 INCLUDE_GRAPH          = YES
131 INCLUDED_BY_GRAPH      = YES
132 CALL_GRAPH             = YES
133 CALLER_GRAPH           = NO
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
142 DOT_CLEANUP            = YES
143
144 #---------------------------------------------------------------------------
145 # Configuration::additions related to the search engine   
146 #---------------------------------------------------------------------------
147
148 SEARCHENGINE           = NO