Skip to content

Commit 4d37d06

Browse files
author
Clint Ascencio
committed
Added doxyfile for documentation
1 parent 1c23228 commit 4d37d06

File tree

1 file changed

+341
-0
lines changed

1 file changed

+341
-0
lines changed

doxyfile

+341
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,341 @@
1+
# Doxyfile 1.8.10
2+
3+
#---------------------------------------------------------------------------
4+
# Project related configuration options
5+
#---------------------------------------------------------------------------
6+
DOXYFILE_ENCODING = UTF-8
7+
PROJECT_NAME = "DataStax PHP Driver"
8+
PROJECT_NUMBER =
9+
PROJECT_BRIEF =
10+
PROJECT_LOGO =
11+
OUTPUT_DIRECTORY =
12+
CREATE_SUBDIRS = NO
13+
ALLOW_UNICODE_NAMES = NO
14+
OUTPUT_LANGUAGE = English
15+
BRIEF_MEMBER_DESC = YES
16+
REPEAT_BRIEF = YES
17+
ABBREVIATE_BRIEF = "The $name class" \
18+
"The $name widget" \
19+
"The $name file" \
20+
is \
21+
provides \
22+
specifies \
23+
contains \
24+
represents \
25+
a \
26+
an \
27+
the
28+
ALWAYS_DETAILED_SEC = NO
29+
INLINE_INHERITED_MEMB = NO
30+
FULL_PATH_NAMES = NO
31+
STRIP_FROM_PATH =
32+
STRIP_FROM_INC_PATH =
33+
SHORT_NAMES = NO
34+
JAVADOC_AUTOBRIEF = NO
35+
QT_AUTOBRIEF = NO
36+
MULTILINE_CPP_IS_BRIEF = NO
37+
INHERIT_DOCS = YES
38+
SEPARATE_MEMBER_PAGES = NO
39+
TAB_SIZE = 4
40+
ALIASES = "throws=\par Throws\n" \
41+
"test_assumptions=\par Test Assumptions\n" \
42+
"note=\par Note\n" \
43+
"test_category=\par Test Category\n" \
44+
"jira_ticket=\par JIRA Ticket\n" \
45+
"expected_result=\par Expected Result\n" \
46+
"since=\par Since\n" \
47+
"param=\par Parameters\n" \
48+
"return=\par Return\n" \
49+
"expected_errors=\par Expected Errors\n" \
50+
"expectedException=\par Expected Exception\n" \
51+
"expectedExceptionMessage=\par Expected Exception Message\n" \
52+
"dataProvider=\par Data Provider\n" \
53+
"requires=\par Requires\n" \
54+
"depends=\par Depends\n"
55+
TCL_SUBST =
56+
OPTIMIZE_OUTPUT_FOR_C = NO
57+
OPTIMIZE_OUTPUT_JAVA = NO
58+
OPTIMIZE_FOR_FORTRAN = NO
59+
OPTIMIZE_OUTPUT_VHDL = NO
60+
EXTENSION_MAPPING =
61+
MARKDOWN_SUPPORT = YES
62+
AUTOLINK_SUPPORT = YES
63+
BUILTIN_STL_SUPPORT = NO
64+
CPP_CLI_SUPPORT = NO
65+
SIP_SUPPORT = NO
66+
IDL_PROPERTY_SUPPORT = YES
67+
DISTRIBUTE_GROUP_DOC = NO
68+
GROUP_NESTED_COMPOUNDS = NO
69+
SUBGROUPING = YES
70+
INLINE_GROUPED_CLASSES = NO
71+
INLINE_SIMPLE_STRUCTS = NO
72+
TYPEDEF_HIDES_STRUCT = NO
73+
LOOKUP_CACHE_SIZE = 0
74+
#---------------------------------------------------------------------------
75+
# Build related configuration options
76+
#---------------------------------------------------------------------------
77+
EXTRACT_ALL = NO
78+
EXTRACT_PRIVATE = NO
79+
EXTRACT_PACKAGE = NO
80+
EXTRACT_STATIC = NO
81+
EXTRACT_LOCAL_CLASSES = YES
82+
EXTRACT_LOCAL_METHODS = NO
83+
EXTRACT_ANON_NSPACES = NO
84+
HIDE_UNDOC_MEMBERS = NO
85+
HIDE_UNDOC_CLASSES = NO
86+
HIDE_FRIEND_COMPOUNDS = NO
87+
HIDE_IN_BODY_DOCS = NO
88+
INTERNAL_DOCS = NO
89+
CASE_SENSE_NAMES = NO
90+
HIDE_SCOPE_NAMES = NO
91+
HIDE_COMPOUND_REFERENCE= NO
92+
SHOW_INCLUDE_FILES = YES
93+
SHOW_GROUPED_MEMB_INC = NO
94+
FORCE_LOCAL_INCLUDES = NO
95+
INLINE_INFO = YES
96+
SORT_MEMBER_DOCS = YES
97+
SORT_BRIEF_DOCS = NO
98+
SORT_MEMBERS_CTORS_1ST = NO
99+
SORT_GROUP_NAMES = NO
100+
SORT_BY_SCOPE_NAME = NO
101+
STRICT_PROTO_MATCHING = NO
102+
GENERATE_TODOLIST = YES
103+
GENERATE_TESTLIST = YES
104+
GENERATE_BUGLIST = YES
105+
GENERATE_DEPRECATEDLIST= YES
106+
ENABLED_SECTIONS =
107+
MAX_INITIALIZER_LINES = 30
108+
SHOW_USED_FILES = YES
109+
SHOW_FILES = YES
110+
SHOW_NAMESPACES = YES
111+
FILE_VERSION_FILTER =
112+
LAYOUT_FILE =
113+
CITE_BIB_FILES =
114+
#---------------------------------------------------------------------------
115+
# Configuration options related to warning and progress messages
116+
#---------------------------------------------------------------------------
117+
QUIET = NO
118+
WARNINGS = YES
119+
WARN_IF_UNDOCUMENTED = YES
120+
WARN_IF_DOC_ERROR = YES
121+
WARN_NO_PARAMDOC = NO
122+
WARN_FORMAT = "$file:$line: $text"
123+
WARN_LOGFILE =
124+
#---------------------------------------------------------------------------
125+
# Configuration options related to the input files
126+
#---------------------------------------------------------------------------
127+
INPUT = ./tests/
128+
INPUT_ENCODING = UTF-8
129+
FILE_PATTERNS = *.php
130+
RECURSIVE = YES
131+
EXCLUDE = @Test
132+
EXCLUDE_SYMLINKS = NO
133+
EXCLUDE_PATTERNS =
134+
EXCLUDE_SYMBOLS =
135+
EXAMPLE_PATH =
136+
EXAMPLE_PATTERNS = *
137+
EXAMPLE_RECURSIVE = NO
138+
IMAGE_PATH =
139+
INPUT_FILTER =
140+
FILTER_PATTERNS =
141+
FILTER_SOURCE_FILES = NO
142+
FILTER_SOURCE_PATTERNS =
143+
USE_MDFILE_AS_MAINPAGE =
144+
#---------------------------------------------------------------------------
145+
# Configuration options related to source browsing
146+
#---------------------------------------------------------------------------
147+
SOURCE_BROWSER = NO
148+
INLINE_SOURCES = NO
149+
STRIP_CODE_COMMENTS = YES
150+
REFERENCED_BY_RELATION = NO
151+
REFERENCES_RELATION = NO
152+
REFERENCES_LINK_SOURCE = YES
153+
SOURCE_TOOLTIPS = YES
154+
USE_HTAGS = NO
155+
VERBATIM_HEADERS = YES
156+
CLANG_ASSISTED_PARSING = NO
157+
CLANG_OPTIONS =
158+
#---------------------------------------------------------------------------
159+
# Configuration options related to the alphabetical class index
160+
#---------------------------------------------------------------------------
161+
ALPHABETICAL_INDEX = YES
162+
COLS_IN_ALPHA_INDEX = 5
163+
IGNORE_PREFIX =
164+
#---------------------------------------------------------------------------
165+
# Configuration options related to the HTML output
166+
#---------------------------------------------------------------------------
167+
GENERATE_HTML = YES
168+
HTML_OUTPUT = html
169+
HTML_FILE_EXTENSION = .html
170+
HTML_HEADER =
171+
HTML_FOOTER =
172+
HTML_STYLESHEET =
173+
HTML_EXTRA_STYLESHEET =
174+
HTML_EXTRA_FILES =
175+
HTML_COLORSTYLE_HUE = 220
176+
HTML_COLORSTYLE_SAT = 100
177+
HTML_COLORSTYLE_GAMMA = 80
178+
HTML_TIMESTAMP = YES
179+
HTML_DYNAMIC_SECTIONS = NO
180+
HTML_INDEX_NUM_ENTRIES = 100
181+
GENERATE_DOCSET = NO
182+
DOCSET_FEEDNAME = "Doxygen generated docs"
183+
DOCSET_BUNDLE_ID = org.doxygen.Project
184+
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
185+
DOCSET_PUBLISHER_NAME = Publisher
186+
GENERATE_HTMLHELP = NO
187+
CHM_FILE =
188+
HHC_LOCATION =
189+
GENERATE_CHI = NO
190+
CHM_INDEX_ENCODING =
191+
BINARY_TOC = NO
192+
TOC_EXPAND = NO
193+
GENERATE_QHP = NO
194+
QCH_FILE =
195+
QHP_NAMESPACE = org.doxygen.Project
196+
QHP_VIRTUAL_FOLDER = doc
197+
QHP_CUST_FILTER_NAME =
198+
QHP_CUST_FILTER_ATTRS =
199+
QHP_SECT_FILTER_ATTRS =
200+
QHG_LOCATION =
201+
GENERATE_ECLIPSEHELP = NO
202+
ECLIPSE_DOC_ID = org.doxygen.Project
203+
DISABLE_INDEX = NO
204+
GENERATE_TREEVIEW = YES
205+
ENUM_VALUES_PER_LINE = 4
206+
TREEVIEW_WIDTH = 250
207+
EXT_LINKS_IN_WINDOW = NO
208+
FORMULA_FONTSIZE = 10
209+
FORMULA_TRANSPARENT = YES
210+
USE_MATHJAX = NO
211+
MATHJAX_FORMAT = HTML-CSS
212+
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
213+
MATHJAX_EXTENSIONS =
214+
MATHJAX_CODEFILE =
215+
SEARCHENGINE = YES
216+
SERVER_BASED_SEARCH = NO
217+
EXTERNAL_SEARCH = NO
218+
SEARCHENGINE_URL =
219+
SEARCHDATA_FILE = searchdata.xml
220+
EXTERNAL_SEARCH_ID =
221+
EXTRA_SEARCH_MAPPINGS =
222+
#---------------------------------------------------------------------------
223+
# Configuration options related to the LaTeX output
224+
#---------------------------------------------------------------------------
225+
GENERATE_LATEX = NO
226+
LATEX_OUTPUT = latex
227+
LATEX_CMD_NAME = latex
228+
MAKEINDEX_CMD_NAME = makeindex
229+
COMPACT_LATEX = NO
230+
PAPER_TYPE = a4
231+
EXTRA_PACKAGES =
232+
LATEX_HEADER =
233+
LATEX_FOOTER =
234+
LATEX_EXTRA_STYLESHEET =
235+
LATEX_EXTRA_FILES =
236+
PDF_HYPERLINKS = YES
237+
USE_PDFLATEX = YES
238+
LATEX_BATCHMODE = NO
239+
LATEX_HIDE_INDICES = NO
240+
LATEX_SOURCE_CODE = NO
241+
LATEX_BIB_STYLE = plain
242+
#---------------------------------------------------------------------------
243+
# Configuration options related to the RTF output
244+
#---------------------------------------------------------------------------
245+
GENERATE_RTF = NO
246+
RTF_OUTPUT = rtf
247+
COMPACT_RTF = NO
248+
RTF_HYPERLINKS = NO
249+
RTF_STYLESHEET_FILE =
250+
RTF_EXTENSIONS_FILE =
251+
RTF_SOURCE_CODE = NO
252+
#---------------------------------------------------------------------------
253+
# Configuration options related to the man page output
254+
#---------------------------------------------------------------------------
255+
GENERATE_MAN = NO
256+
MAN_OUTPUT = man
257+
MAN_EXTENSION = .3
258+
MAN_SUBDIR =
259+
MAN_LINKS = NO
260+
#---------------------------------------------------------------------------
261+
# Configuration options related to the XML output
262+
#---------------------------------------------------------------------------
263+
GENERATE_XML = NO
264+
XML_OUTPUT = xml
265+
XML_PROGRAMLISTING = YES
266+
#---------------------------------------------------------------------------
267+
# Configuration options related to the DOCBOOK output
268+
#---------------------------------------------------------------------------
269+
GENERATE_DOCBOOK = NO
270+
DOCBOOK_OUTPUT = docbook
271+
DOCBOOK_PROGRAMLISTING = NO
272+
#---------------------------------------------------------------------------
273+
# Configuration options for the AutoGen Definitions output
274+
#---------------------------------------------------------------------------
275+
GENERATE_AUTOGEN_DEF = NO
276+
#---------------------------------------------------------------------------
277+
# Configuration options related to the Perl module output
278+
#---------------------------------------------------------------------------
279+
GENERATE_PERLMOD = NO
280+
PERLMOD_LATEX = NO
281+
PERLMOD_PRETTY = YES
282+
PERLMOD_MAKEVAR_PREFIX =
283+
#---------------------------------------------------------------------------
284+
# Configuration options related to the preprocessor
285+
#---------------------------------------------------------------------------
286+
ENABLE_PREPROCESSING = YES
287+
MACRO_EXPANSION = NO
288+
EXPAND_ONLY_PREDEF = NO
289+
SEARCH_INCLUDES = YES
290+
INCLUDE_PATH =
291+
INCLUDE_FILE_PATTERNS =
292+
PREDEFINED =
293+
EXPAND_AS_DEFINED =
294+
SKIP_FUNCTION_MACROS = YES
295+
#---------------------------------------------------------------------------
296+
# Configuration options related to external references
297+
#---------------------------------------------------------------------------
298+
TAGFILES =
299+
GENERATE_TAGFILE =
300+
ALLEXTERNALS = NO
301+
EXTERNAL_GROUPS = YES
302+
EXTERNAL_PAGES = YES
303+
PERL_PATH = /usr/bin/perl
304+
#---------------------------------------------------------------------------
305+
# Configuration options related to the dot tool
306+
#---------------------------------------------------------------------------
307+
CLASS_DIAGRAMS = YES
308+
MSCGEN_PATH =
309+
DIA_PATH =
310+
HIDE_UNDOC_RELATIONS = YES
311+
HAVE_DOT = NO
312+
DOT_NUM_THREADS = 0
313+
DOT_FONTNAME = Helvetica
314+
DOT_FONTSIZE = 10
315+
DOT_FONTPATH =
316+
CLASS_GRAPH = YES
317+
COLLABORATION_GRAPH = YES
318+
GROUP_GRAPHS = YES
319+
UML_LOOK = NO
320+
UML_LIMIT_NUM_FIELDS = 10
321+
TEMPLATE_RELATIONS = NO
322+
INCLUDE_GRAPH = YES
323+
INCLUDED_BY_GRAPH = YES
324+
CALL_GRAPH = NO
325+
CALLER_GRAPH = NO
326+
GRAPHICAL_HIERARCHY = YES
327+
DIRECTORY_GRAPH = YES
328+
DOT_IMAGE_FORMAT = png
329+
INTERACTIVE_SVG = NO
330+
DOT_PATH =
331+
DOTFILE_DIRS =
332+
MSCFILE_DIRS =
333+
DIAFILE_DIRS =
334+
PLANTUML_JAR_PATH =
335+
PLANTUML_INCLUDE_PATH =
336+
DOT_GRAPH_MAX_NODES = 50
337+
MAX_DOT_GRAPH_DEPTH = 0
338+
DOT_TRANSPARENT = NO
339+
DOT_MULTI_TARGETS = NO
340+
GENERATE_LEGEND = YES
341+
DOT_CLEANUP = YES

0 commit comments

Comments
 (0)