source: libcaca/trunk/doc/doxygen.cfg.in @ 268

Last change on this file since 268 was 268, checked in by Sam Hocevar, 19 years ago
  • src/io.c: + Added caca_wait_event(), a blocking caca_get_event().
  • src/ examples/: + More documentation.
  • doc/doxygen.cfg.in: + doc/doxygen.cfg is now generated by configure, so that we can use

@top_srcdir@ and we no longer need to hardcode PROJECT_NUMBER.

+ Create manpages.

File size: 7.9 KB
Line 
1# Doxyfile 1.3.4
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME           = @PACKAGE@
7PROJECT_NUMBER         = @VERSION@
8OUTPUT_DIRECTORY       = .
9OUTPUT_LANGUAGE        = English
10USE_WINDOWS_ENCODING   = NO
11BRIEF_MEMBER_DESC      = YES
12REPEAT_BRIEF           = NO
13ALWAYS_DETAILED_SEC    = NO
14INLINE_INHERITED_MEMB  = NO
15FULL_PATH_NAMES        = NO
16STRIP_FROM_PATH        =
17SHORT_NAMES            = NO
18JAVADOC_AUTOBRIEF      = NO
19MULTILINE_CPP_IS_BRIEF = NO
20DETAILS_AT_TOP         = NO
21INHERIT_DOCS           = YES
22DISTRIBUTE_GROUP_DOC   = NO
23TAB_SIZE               = 8
24ALIASES                =
25OPTIMIZE_OUTPUT_FOR_C  = YES
26OPTIMIZE_OUTPUT_JAVA   = NO
27SUBGROUPING            = YES
28#---------------------------------------------------------------------------
29# Build related configuration options
30#---------------------------------------------------------------------------
31EXTRACT_ALL            = NO
32EXTRACT_PRIVATE        = NO
33EXTRACT_STATIC         = NO
34EXTRACT_LOCAL_CLASSES  = YES
35HIDE_UNDOC_MEMBERS     = NO
36HIDE_UNDOC_CLASSES     = NO
37HIDE_FRIEND_COMPOUNDS  = NO
38HIDE_IN_BODY_DOCS      = NO
39INTERNAL_DOCS          = NO
40CASE_SENSE_NAMES       = NO
41HIDE_SCOPE_NAMES       = NO
42SHOW_INCLUDE_FILES     = NO
43INLINE_INFO            = YES
44SORT_MEMBER_DOCS       = YES
45GENERATE_TODOLIST      = YES
46GENERATE_TESTLIST      = YES
47GENERATE_BUGLIST       = YES
48GENERATE_DEPRECATEDLIST= YES
49ENABLED_SECTIONS       =
50MAX_INITIALIZER_LINES  = 30
51SHOW_USED_FILES        = YES
52#---------------------------------------------------------------------------
53# configuration options related to warning and progress messages
54#---------------------------------------------------------------------------
55QUIET                  = NO
56WARNINGS               = YES
57WARN_IF_UNDOCUMENTED   = YES
58WARN_IF_DOC_ERROR      = YES
59WARN_FORMAT            = "$file:$line: $text"
60WARN_LOGFILE           =
61#---------------------------------------------------------------------------
62# configuration options related to the input files
63#---------------------------------------------------------------------------
64INPUT                  = @top_srcdir@/src
65FILE_PATTERNS          = *.c \
66                         *.h
67RECURSIVE              = YES
68EXCLUDE                = ../src/config.h
69EXCLUDE_SYMLINKS       = NO
70EXCLUDE_PATTERNS       = *_private.h
71EXAMPLE_PATH           =
72EXAMPLE_PATTERNS       =
73EXAMPLE_RECURSIVE      = NO
74IMAGE_PATH             =
75INPUT_FILTER           =
76FILTER_SOURCE_FILES    = NO
77#---------------------------------------------------------------------------
78# configuration options related to source browsing
79#---------------------------------------------------------------------------
80SOURCE_BROWSER         = NO
81INLINE_SOURCES         = NO
82STRIP_CODE_COMMENTS    = YES
83REFERENCED_BY_RELATION = YES
84REFERENCES_RELATION    = YES
85VERBATIM_HEADERS       = YES
86#---------------------------------------------------------------------------
87# configuration options related to the alphabetical class index
88#---------------------------------------------------------------------------
89ALPHABETICAL_INDEX     = NO
90COLS_IN_ALPHA_INDEX    = 5
91IGNORE_PREFIX          =
92#---------------------------------------------------------------------------
93# configuration options related to the HTML output
94#---------------------------------------------------------------------------
95GENERATE_HTML          = YES
96HTML_OUTPUT            = html
97HTML_FILE_EXTENSION    = .html
98HTML_HEADER            = @srcdir@/header.html
99HTML_FOOTER            = @srcdir@/footer.html
100HTML_STYLESHEET        =
101HTML_ALIGN_MEMBERS     = YES
102GENERATE_HTMLHELP      = NO
103CHM_FILE               =
104HHC_LOCATION           =
105GENERATE_CHI           = NO
106BINARY_TOC             = NO
107TOC_EXPAND             = NO
108DISABLE_INDEX          = NO
109ENUM_VALUES_PER_LINE   = 4
110GENERATE_TREEVIEW      = NO
111TREEVIEW_WIDTH         = 250
112#---------------------------------------------------------------------------
113# configuration options related to the LaTeX output
114#---------------------------------------------------------------------------
115GENERATE_LATEX         = YES
116LATEX_OUTPUT           = latex
117LATEX_CMD_NAME         = latex
118MAKEINDEX_CMD_NAME     = makeindex
119COMPACT_LATEX          = NO
120PAPER_TYPE             = a4wide
121EXTRA_PACKAGES         =
122LATEX_HEADER           =
123PDF_HYPERLINKS         = NO
124USE_PDFLATEX           = NO
125LATEX_BATCHMODE        = NO
126LATEX_HIDE_INDICES     = NO
127#---------------------------------------------------------------------------
128# configuration options related to the RTF output
129#---------------------------------------------------------------------------
130GENERATE_RTF           = NO
131RTF_OUTPUT             = rtf
132COMPACT_RTF            = NO
133RTF_HYPERLINKS         = NO
134RTF_STYLESHEET_FILE    =
135RTF_EXTENSIONS_FILE    =
136#---------------------------------------------------------------------------
137# configuration options related to the man page output
138#---------------------------------------------------------------------------
139GENERATE_MAN           = YES
140MAN_OUTPUT             = man
141MAN_EXTENSION          = .3caca
142MAN_LINKS              = YES
143#---------------------------------------------------------------------------
144# configuration options related to the XML output
145#---------------------------------------------------------------------------
146GENERATE_XML           = NO
147XML_OUTPUT             = xml
148XML_SCHEMA             =
149XML_DTD                =
150#---------------------------------------------------------------------------
151# configuration options for the AutoGen Definitions output
152#---------------------------------------------------------------------------
153GENERATE_AUTOGEN_DEF   = NO
154#---------------------------------------------------------------------------
155# configuration options related to the Perl module output
156#---------------------------------------------------------------------------
157GENERATE_PERLMOD       = NO
158PERLMOD_LATEX          = NO
159PERLMOD_PRETTY         = YES
160PERLMOD_MAKEVAR_PREFIX =
161#---------------------------------------------------------------------------
162# Configuration options related to the preprocessor   
163#---------------------------------------------------------------------------
164ENABLE_PREPROCESSING   = YES
165MACRO_EXPANSION        = NO
166EXPAND_ONLY_PREDEF     = NO
167SEARCH_INCLUDES        = YES
168INCLUDE_PATH           =
169INCLUDE_FILE_PATTERNS  =
170PREDEFINED             = _DOXYGEN_SKIP_ME \
171                         USE_X11 \
172                         USE_CONIO \
173                         USE_NCURSES \
174                         USE_SLANG
175EXPAND_AS_DEFINED      =
176SKIP_FUNCTION_MACROS   = YES
177#---------------------------------------------------------------------------
178# Configuration::addtions related to external references   
179#---------------------------------------------------------------------------
180TAGFILES               =
181GENERATE_TAGFILE       =
182ALLEXTERNALS           = NO
183EXTERNAL_GROUPS        = YES
184PERL_PATH              = /usr/bin/perl
185#---------------------------------------------------------------------------
186# Configuration options related to the dot tool   
187#---------------------------------------------------------------------------
188CLASS_DIAGRAMS         = YES
189HIDE_UNDOC_RELATIONS   = YES
190HAVE_DOT               = NO
191CLASS_GRAPH            = YES
192COLLABORATION_GRAPH    = YES
193UML_LOOK               = NO
194TEMPLATE_RELATIONS     = YES
195INCLUDE_GRAPH          = YES
196INCLUDED_BY_GRAPH      = YES
197CALL_GRAPH             = NO
198GRAPHICAL_HIERARCHY    = YES
199DOT_IMAGE_FORMAT       = png
200DOT_PATH               =
201DOTFILE_DIRS           = .
202MAX_DOT_GRAPH_WIDTH    = 1024
203MAX_DOT_GRAPH_HEIGHT   = 1024
204MAX_DOT_GRAPH_DEPTH    = 0
205GENERATE_LEGEND        = YES
206DOT_CLEANUP            = YES
207#---------------------------------------------------------------------------
208# Configuration::addtions related to the search engine   
209#---------------------------------------------------------------------------
210SEARCHENGINE           = NO
Note: See TracBrowser for help on using the repository browser.