Some refactoring, partially to accommodate changes suggested by douggreen. The basic...
[project/panels.git] / panels2.doxy
CommitLineData
f2e5a0c5
EM
1# $Id$
2# Doxyfile 1.5.6
3
4# MAKE SURE to replace the ${variable} values with settings appropriate
5# to your system!
6
7#---------------------------------------------------------------------------
8# Project related configuration options
9#---------------------------------------------------------------------------
10DOXYFILE_ENCODING = UTF-8
11PROJECT_NAME = "Panels 2"
12PROJECT_NUMBER =
13OUTPUT_DIRECTORY = ${OUTPUT}/panels2
14CREATE_SUBDIRS = NO
15OUTPUT_LANGUAGE = English
16BRIEF_MEMBER_DESC = YES
17REPEAT_BRIEF = NO
18ABBREVIATE_BRIEF =
19ALWAYS_DETAILED_SEC = YES
20INLINE_INHERITED_MEMB = NO
21FULL_PATH_NAMES = YES
22STRIP_FROM_PATH = ${MODULE_PATH}
23STRIP_FROM_INC_PATH =
24SHORT_NAMES = NO
25JAVADOC_AUTOBRIEF = NO
26QT_AUTOBRIEF = NO
27MULTILINE_CPP_IS_BRIEF = NO
28DETAILS_AT_TOP = YES
29INHERIT_DOCS = YES
30SEPARATE_MEMBER_PAGES = NO
31TAB_SIZE = 2
32ALIASES = "L{1}=\ref @w{\m}\1" \
33 "m=panels_" \
34 "mA=@w{@m}api_" \
35 "mG=@w{@m}glossary_" \
36 "mAP=@w{@mA}plugins_" \
37 "mGs=@w{@mG}sec_" \
38 "mGt=@w{@mG}term_" \
39 "LA{1}=\ref @w{@mA}\1" \
40 "LAP{1}=\ref @w{@mAP}\1" \
41 "LGt{1}=\ref @w{@mGt}\1" \
42 "L{2}=\ref @w{@m}\1 \"\2\"" \
43 "LA{2}=\ref @w{@mA}\1 \"\2\"" \
44 "LAP{2}=\ref @w{@mAP}\1 \"\2\"" \
45 "LAP{3}=\ref @w{@mAP}\1_\2 \"\3\"" \
46 "LGt{2}=\ref @w{@mGt}\1 \"\2\"" \
47 "AG{2}=\par \anchor @w{\mGt}\1 \LITI{\2} \n" \
48 "AAP{3}=\anchor @w{\mAP}\1_\2 \3" \
49 "SECglossary{2}=\section @w{@mGs}\1 \2" \
50 "SSECglossary{3}=\subsection @w{@mGs}\1_\2 \3" \
51 "Psubplug{2}=\subpage @w{@mAP}\1 \"\2\"" \
52 "Pplug{2}=\page @w{@mAP}\1 \2" \
53 "SECplug{3}=\section @w{@mAP}\1_\2 \3" \
54 "SSECplug{4}=\subsection @w{@mAP}\1_\2_\3 \4" \
55 "S{1}=<strong>@w{\1}</strong>" \
56 "E{1}=<em>@w{\1}</em>" \
57 "LITI{1}=<strong><em>@w{\1}:</em></strong>" \
58 "IMG{2}=\image html \1 \"\2\"" \
59 "TR{1}=<tr>@w{\1}</tr>" \
60 "TD{1}=<td>@w{\1}</td>" \
61 "pdarray=\LGt{p-d-array,plugin definition array}" \
62 "pdfunc=\LGt{p-d-func,plugin declaration function}" \
63 "pdarrays=\LGt{p-d-array,plugin definition arrays}" \
64 "pdfuncs=\LGt{p-d-func,plugin declaration functions}" \
65 "plugprops=\LGt{plugprop,properties}" \
66 "plugprop=\LGt{plugprop,property}" \
67 "w{1}=\1" # uber wrapper of godly doxy substitution!
68OPTIMIZE_OUTPUT_FOR_C = NO
69OPTIMIZE_OUTPUT_JAVA = NO
70OPTIMIZE_FOR_FORTRAN = NO
71OPTIMIZE_OUTPUT_VHDL = NO
72BUILTIN_STL_SUPPORT = NO
73CPP_CLI_SUPPORT = NO
74SIP_SUPPORT = NO
75IDL_PROPERTY_SUPPORT = NO
76DISTRIBUTE_GROUP_DOC = NO
77SUBGROUPING = YES
78TYPEDEF_HIDES_STRUCT = NO
79#---------------------------------------------------------------------------
80# Build related configuration options
81#---------------------------------------------------------------------------
82EXTRACT_ALL = YES
83EXTRACT_PRIVATE = YES
84EXTRACT_STATIC = YES
85EXTRACT_LOCAL_CLASSES = YES
86EXTRACT_LOCAL_METHODS = NO
87EXTRACT_ANON_NSPACES = YES
88HIDE_UNDOC_MEMBERS = NO
89HIDE_UNDOC_CLASSES = NO
90HIDE_FRIEND_COMPOUNDS = NO
91HIDE_IN_BODY_DOCS = NO
92INTERNAL_DOCS = NO
93CASE_SENSE_NAMES = YES
94HIDE_SCOPE_NAMES = NO
95SHOW_INCLUDE_FILES = YES
96INLINE_INFO = YES
97SORT_MEMBER_DOCS = YES
98SORT_BRIEF_DOCS = YES
99SORT_GROUP_NAMES = YES
100SORT_BY_SCOPE_NAME = YES
101GENERATE_TODOLIST = YES
102GENERATE_TESTLIST = YES
103GENERATE_BUGLIST = YES
104GENERATE_DEPRECATEDLIST= YES
105ENABLED_SECTIONS = YES
106MAX_INITIALIZER_LINES = 30
107SHOW_USED_FILES = YES
108SHOW_DIRECTORIES = YES
109SHOW_FILES = YES
110SHOW_NAMESPACES = YES
111FILE_VERSION_FILTER = "sed -n 's/^.*\$Id: [^ \]* \(.*\) Exp.*/\1/p'"
112#---------------------------------------------------------------------------
113# configuration options related to warning and progress messages
114#---------------------------------------------------------------------------
115QUIET = YES
116WARNINGS = YES
117WARN_IF_UNDOCUMENTED = NO
118WARN_IF_DOC_ERROR = YES
119WARN_NO_PARAMDOC = YES
120WARN_FORMAT = "$line: $text"
121WARN_LOGFILE = /var/log/doxy/drupal-doxy.log
122#---------------------------------------------------------------------------
123# configuration options related to the input files
124#---------------------------------------------------------------------------
125INPUT = ${MODULE_PATH}
126INPUT_ENCODING = UTF-8
127FILE_PATTERNS = *.module \
128 *.theme \
129 *.engine \
130 *.install \
131 *.inc
132RECURSIVE = YES
133EXCLUDE =
134EXCLUDE_SYMLINKS = YES
135EXCLUDE_PATTERNS = */.svn/* \
136 */CVS/* \
137 */cvs-release-notes.php \
138 */patches/*
139EXCLUDE_SYMBOLS =
140EXAMPLE_PATH = ${MODULE_PATH}/docs
141EXAMPLE_PATTERNS = *
142EXAMPLE_RECURSIVE = NO
143IMAGE_PATH = html/images
144INPUT_FILTER =
145FILTER_PATTERNS =
146FILTER_SOURCE_FILES = NO
147#---------------------------------------------------------------------------
148# configuration options related to source browsing
149#---------------------------------------------------------------------------
150SOURCE_BROWSER = YES
151INLINE_SOURCES = YES
152STRIP_CODE_COMMENTS = NO
153REFERENCED_BY_RELATION = YES
154REFERENCES_RELATION = YES
155REFERENCES_LINK_SOURCE = YES
156USE_HTAGS = NO
157VERBATIM_HEADERS = YES
158#---------------------------------------------------------------------------
159# configuration options related to the alphabetical class index
160#---------------------------------------------------------------------------
161ALPHABETICAL_INDEX = YES
162COLS_IN_ALPHA_INDEX = 5
163IGNORE_PREFIX =
164#---------------------------------------------------------------------------
165# configuration options related to the HTML output
166#---------------------------------------------------------------------------
167GENERATE_HTML = YES
168HTML_OUTPUT = html
169HTML_FILE_EXTENSION = .html
170HTML_HEADER =
171HTML_FOOTER =
172HTML_STYLESHEET = ${MODULE_PATH}/docs/doxygen.css
173HTML_ALIGN_MEMBERS = YES
174GENERATE_HTMLHELP = NO
175GENERATE_DOCSET = NO
176DOCSET_FEEDNAME =
177DOCSET_BUNDLE_ID =
178HTML_DYNAMIC_SECTIONS = YES
179CHM_FILE =
180HHC_LOCATION =
181GENERATE_CHI = NO
182CHM_INDEX_ENCODING =
183BINARY_TOC = NO
184TOC_EXPAND = YES
185DISABLE_INDEX = NO
186ENUM_VALUES_PER_LINE = 4
187GENERATE_TREEVIEW = YES
188TREEVIEW_WIDTH = 250
189FORMULA_FONTSIZE = 10
190#---------------------------------------------------------------------------
191# configuration options related to the LaTeX output
192#---------------------------------------------------------------------------
193GENERATE_LATEX = NO
194LATEX_OUTPUT = latex
195LATEX_CMD_NAME = latex
196MAKEINDEX_CMD_NAME =
197COMPACT_LATEX = NO
198PAPER_TYPE = letter
199EXTRA_PACKAGES =
200LATEX_HEADER =
201PDF_HYPERLINKS = YES
202USE_PDFLATEX = YES
203LATEX_BATCHMODE = YES
204LATEX_HIDE_INDICES = NO
205#---------------------------------------------------------------------------
206# configuration options related to the RTF output
207#---------------------------------------------------------------------------
208GENERATE_RTF = NO
209RTF_OUTPUT = rtf
210COMPACT_RTF = NO
211RTF_HYPERLINKS = NO
212RTF_STYLESHEET_FILE =
213RTF_EXTENSIONS_FILE =
214#---------------------------------------------------------------------------
215# configuration options related to the man page output
216#---------------------------------------------------------------------------
217GENERATE_MAN = NO
218MAN_OUTPUT = man
219MAN_EXTENSION = .3
220MAN_LINKS = NO
221#---------------------------------------------------------------------------
222# configuration options related to the XML output
223#---------------------------------------------------------------------------
224GENERATE_XML = YES
225XML_OUTPUT = xml
226XML_SCHEMA =
227XML_DTD =
228XML_PROGRAMLISTING = YES
229#---------------------------------------------------------------------------
230# configuration options for the AutoGen Definitions output
231#---------------------------------------------------------------------------
232GENERATE_AUTOGEN_DEF = NO
233#---------------------------------------------------------------------------
234# configuration options related to the Perl module output
235#---------------------------------------------------------------------------
236GENERATE_PERLMOD = NO
237PERLMOD_LATEX = NO
238PERLMOD_PRETTY = YES
239PERLMOD_MAKEVAR_PREFIX =
240#---------------------------------------------------------------------------
241# Configuration options related to the preprocessor
242#---------------------------------------------------------------------------
243ENABLE_PREPROCESSING = YES
244MACRO_EXPANSION = NO
245EXPAND_ONLY_PREDEF = NO
246SEARCH_INCLUDES = YES
247INCLUDE_PATH =
248INCLUDE_FILE_PATTERNS =
249PREDEFINED =
250EXPAND_AS_DEFINED =
251SKIP_FUNCTION_MACROS = YES
252#---------------------------------------------------------------------------
253# Configuration::additions related to external references
254#---------------------------------------------------------------------------
255TAGFILES =
256GENERATE_TAGFILE =
257ALLEXTERNALS = NO
258EXTERNAL_GROUPS = YES
259PERL_PATH = /usr/bin/perl
260#---------------------------------------------------------------------------
261# Configuration options related to the dot tool
262#---------------------------------------------------------------------------
263CLASS_DIAGRAMS = YES
264MSCGEN_PATH = /usr/local/bin
265HIDE_UNDOC_RELATIONS = NO
266HAVE_DOT = YES
267DOT_FONTNAME = FreeSans
268DOT_FONTPATH =
269CLASS_GRAPH = YES
270COLLABORATION_GRAPH = YES
271GROUP_GRAPHS = YES
272UML_LOOK = YES
273TEMPLATE_RELATIONS = YES
274INCLUDE_GRAPH = YES
275INCLUDED_BY_GRAPH = YES
276CALL_GRAPH = YES
277CALLER_GRAPH = YES
278GRAPHICAL_HIERARCHY = YES
279DIRECTORY_GRAPH = NO
280DOT_IMAGE_FORMAT = png
281DOT_PATH =
282DOTFILE_DIRS =
283DOT_GRAPH_MAX_NODES = 50
284MAX_DOT_GRAPH_DEPTH = 0
285DOT_TRANSPARENT = YES
286DOT_MULTI_TARGETS = YES
287GENERATE_LEGEND = YES
288DOT_CLEANUP = YES
289#---------------------------------------------------------------------------
290# Configuration::additions related to the search engine
291#---------------------------------------------------------------------------
292SEARCHENGINE = YES