Skip to content

Commit 24aa301

Browse files
Clint Ascencioolim7t
authored andcommitted
Added doxyfile_java to generate documentation
1 parent f188871 commit 24aa301

1 file changed

Lines changed: 336 additions & 0 deletions

File tree

doxyfile

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

0 commit comments

Comments
 (0)