blob: cd3f8e4c460fed84574c64d002577c1560dacf19 [file] [log] [blame]
Tristan Matthews0a329cc2013-07-17 13:20:14 -04001# Doxyfile 1.3-rc3
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# General configuration options
15#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME = "PJSIP Reference"
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
26PROJECT_NUMBER = $(PJ_VERSION)
27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33OUTPUT_DIRECTORY = docs/$(PJ_VERSION)
34
35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36# documentation generated by doxygen is written. Doxygen will use this
37# information to generate all constant output in the proper language.
38# The default language is English, other supported languages are:
39# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
42# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
43
44OUTPUT_LANGUAGE = English
45
46# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
47# documentation are documented, even if no documentation was available.
48# Private class members and static file members will be hidden unless
49# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
50
51EXTRACT_ALL = NO
52
53# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
54# will be included in the documentation.
55
56EXTRACT_PRIVATE = NO
57
58# If the EXTRACT_STATIC tag is set to YES all static members of a file
59# will be included in the documentation.
60
61EXTRACT_STATIC = NO
62
63# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
64# defined locally in source files will be included in the documentation.
65# If set to NO only classes defined in header files are included.
66
67EXTRACT_LOCAL_CLASSES = YES
68
69# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
70# undocumented members of documented classes, files or namespaces.
71# If set to NO (the default) these members will be included in the
72# various overviews, but no documentation section is generated.
73# This option has no effect if EXTRACT_ALL is enabled.
74
75HIDE_UNDOC_MEMBERS = NO
76
77# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
78# undocumented classes that are normally visible in the class hierarchy.
79# If set to NO (the default) these class will be included in the various
80# overviews. This option has no effect if EXTRACT_ALL is enabled.
81
82HIDE_UNDOC_CLASSES = YES
83
84# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
85# friend (class|struct|union) declarations.
86# If set to NO (the default) these declarations will be included in the
87# documentation.
88
89HIDE_FRIEND_COMPOUNDS = NO
90
91# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
92# documentation blocks found inside the body of a function.
93# If set to NO (the default) these blocks will be appended to the
94# function's detailed documentation block.
95
96HIDE_IN_BODY_DOCS = NO
97
98# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
99# include brief member descriptions after the members that are listed in
100# the file and class documentation (similar to JavaDoc).
101# Set to NO to disable this.
102
103BRIEF_MEMBER_DESC = YES
104
105# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
106# the brief description of a member or function before the detailed description.
107# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
108# brief descriptions will be completely suppressed.
109
110REPEAT_BRIEF = NO
111
112# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
113# Doxygen will generate a detailed section even if there is only a brief
114# description.
115
116ALWAYS_DETAILED_SEC = YES
117
118# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
119# members of a class in the documentation of that class as if those members were
120# ordinary class members. Constructors, destructors and assignment operators of
121# the base classes will not be shown.
122
123INLINE_INHERITED_MEMB = NO
124
125# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
126# path before files name in the file list and in the header files. If set
127# to NO the shortest path that makes the file name unique will be used.
128
129FULL_PATH_NAMES = NO
130
131# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
132# can be used to strip a user defined part of the path. Stripping is
133# only done if one of the specified strings matches the left-hand part of
134# the path. It is allowed to use relative paths in the argument list.
135
136#STRIP_FROM_PATH = "/cygdrive/e/project/bulukucing.org/pjsip/src"
137STRIP_FROM_PATH = "/c/project/pjproject/pjsip"
138
139# The INTERNAL_DOCS tag determines if documentation
140# that is typed after a \internal command is included. If the tag is set
141# to NO (the default) then the documentation will be excluded.
142# Set it to YES to include the internal documentation.
143
144INTERNAL_DOCS = NO
145
146# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
147# file names in lower case letters. If set to YES upper case letters are also
148# allowed. This is useful if you have classes or files whose names only differ
149# in case and if your file system supports case sensitive file names. Windows
150# users are adviced to set this option to NO.
151
152CASE_SENSE_NAMES = YES
153
154# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
155# (but less readable) file names. This can be useful is your file systems
156# doesn't support long names like on DOS, Mac, or CD-ROM.
157
158SHORT_NAMES = NO
159
160# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
161# will show members with their full class and namespace scopes in the
162# documentation. If set to YES the scope will be hidden.
163
164HIDE_SCOPE_NAMES = NO
165
166# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
167# will generate a verbatim copy of the header file for each class for
168# which an include is specified. Set to NO to disable this.
169
170VERBATIM_HEADERS = NO
171
172# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
173# will put list of the files that are included by a file in the documentation
174# of that file.
175
176SHOW_INCLUDE_FILES = YES
177
178# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
179# will interpret the first line (until the first dot) of a JavaDoc-style
180# comment as the brief description. If set to NO, the JavaDoc
181# comments will behave just like the Qt-style comments (thus requiring an
182# explict @brief command for a brief description.
183
184JAVADOC_AUTOBRIEF = NO
185
186# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
187# treat a multi-line C++ special comment block (i.e. a block of //! or ///
188# comments) as a brief description. This used to be the default behaviour.
189# The new default is to treat a multi-line C++ comment block as a detailed
190# description. Set this tag to YES if you prefer the old behaviour instead.
191
192MULTILINE_CPP_IS_BRIEF = NO
193
194# If the DETAILS_AT_TOP tag is set to YES then Doxygen
195# will output the detailed description near the top, like JavaDoc.
196# If set to NO, the detailed description appears after the member
197# documentation.
198
199DETAILS_AT_TOP = YES
200
201# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
202# member inherits the documentation from any documented member that it
203# reimplements.
204
205INHERIT_DOCS = YES
206
207# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
208# is inserted in the documentation for inline members.
209
210INLINE_INFO = YES
211
212# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
213# will sort the (detailed) documentation of file and class members
214# alphabetically by member name. If set to NO the members will appear in
215# declaration order.
216
217SORT_MEMBER_DOCS = NO
218
219# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
220# tag is set to YES, then doxygen will reuse the documentation of the first
221# member in the group (if any) for the other members of the group. By default
222# all members of a group must be documented explicitly.
223
224DISTRIBUTE_GROUP_DOC = NO
225
226# The TAB_SIZE tag can be used to set the number of spaces in a tab.
227# Doxygen uses this value to replace tabs by spaces in code fragments.
228
229TAB_SIZE = 8
230
231# The GENERATE_TODOLIST tag can be used to enable (YES) or
232# disable (NO) the todo list. This list is created by putting \todo
233# commands in the documentation.
234
235GENERATE_TODOLIST = YES
236
237# The GENERATE_TESTLIST tag can be used to enable (YES) or
238# disable (NO) the test list. This list is created by putting \test
239# commands in the documentation.
240
241GENERATE_TESTLIST = YES
242
243# The GENERATE_BUGLIST tag can be used to enable (YES) or
244# disable (NO) the bug list. This list is created by putting \bug
245# commands in the documentation.
246
247GENERATE_BUGLIST = YES
248
249# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
250# disable (NO) the deprecated list. This list is created by putting
251# \deprecated commands in the documentation.
252
253GENERATE_DEPRECATEDLIST= YES
254
255# This tag can be used to specify a number of aliases that acts
256# as commands in the documentation. An alias has the form "name=value".
257# For example adding "sideeffect=\par Side Effects:\n" will allow you to
258# put the command \sideeffect (or @sideeffect) in the documentation, which
259# will result in a user defined paragraph with heading "Side Effects:".
260# You can put \n's in the value part of an alias to insert newlines.
261
262ALIASES =
263
264# The ENABLED_SECTIONS tag can be used to enable conditional
265# documentation sections, marked by \if sectionname ... \endif.
266
267ENABLED_SECTIONS =
268
269# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
270# the initial value of a variable or define consist of for it to appear in
271# the documentation. If the initializer consists of more lines than specified
272# here it will be hidden. Use a value of 0 to hide initializers completely.
273# The appearance of the initializer of individual variables and defines in the
274# documentation can be controlled using \showinitializer or \hideinitializer
275# command in the documentation regardless of this setting.
276
277MAX_INITIALIZER_LINES = 30
278
279# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
280# only. Doxygen will then generate output that is more tailored for C.
281# For instance some of the names that are used will be different. The list
282# of all members will be omitted, etc.
283
284OPTIMIZE_OUTPUT_FOR_C = YES
285
286# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
287# only. Doxygen will then generate output that is more tailored for Java.
288# For instance namespaces will be presented as packages, qualified scopes
289# will look different, etc.
290
291OPTIMIZE_OUTPUT_JAVA = NO
292
293# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
294# at the bottom of the documentation of classes and structs. If set to YES the
295# list will mention the files that were used to generate the documentation.
296
297SHOW_USED_FILES = YES
298TYPEDEF_HIDES_STRUCT = YES
299
300#---------------------------------------------------------------------------
301# configuration options related to warning and progress messages
302#---------------------------------------------------------------------------
303
304# The QUIET tag can be used to turn on/off the messages that are generated
305# by doxygen. Possible values are YES and NO. If left blank NO is used.
306
307QUIET = NO
308
309# The WARNINGS tag can be used to turn on/off the warning messages that are
310# generated by doxygen. Possible values are YES and NO. If left blank
311# NO is used.
312
313WARNINGS = YES
314
315# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
316# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
317# automatically be disabled.
318
319WARN_IF_UNDOCUMENTED = YES
320
321# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
322# potential errors in the documentation, such as not documenting some
323# parameters in a documented function, or documenting parameters that
324# don't exist or using markup commands wrongly.
325
326WARN_IF_DOC_ERROR = YES
327
328# The WARN_FORMAT tag determines the format of the warning messages that
329# doxygen can produce. The string should contain the $file, $line, and $text
330# tags, which will be replaced by the file and line number from which the
331# warning originated and the warning text.
332
333WARN_FORMAT = "$file:$line: $text"
334
335# The WARN_LOGFILE tag can be used to specify a file to which warning
336# and error messages should be written. If left blank the output is written
337# to stderr.
338
339WARN_LOGFILE =
340
341#---------------------------------------------------------------------------
342# configuration options related to the input files
343#---------------------------------------------------------------------------
344
345# The INPUT tag can be used to specify the files and/or directories that contain
346# documented source files. You may enter file names like "myfile.cpp" or
347# directories like "/usr/src/myproject". Separate the files or directories
348# with spaces.
349
350INPUT = docs include
351
352# If the value of the INPUT tag contains directories, you can use the
353# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
354# and *.h) to filter out the source-files in the directories. If left
355# blank the following patterns are tested:
356# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
357# *.h++ *.idl *.odl
358
359FILE_PATTERNS = *.h
360
361# The RECURSIVE tag can be used to turn specify whether or not subdirectories
362# should be searched for input files as well. Possible values are YES and NO.
363# If left blank NO is used.
364
365RECURSIVE = YES
366
367# The EXCLUDE tag can be used to specify files and/or directories that should
368# excluded from the INPUT source files. This way you can easily exclude a
369# subdirectory from a directory tree whose root is specified with the INPUT tag.
370
371EXCLUDE = *_i.h pjsua_internal.h
372
373# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
374# that are symbolic links (a Unix filesystem feature) are excluded from the input.
375
376EXCLUDE_SYMLINKS = NO
377
378# If the value of the INPUT tag contains directories, you can use the
379# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
380# certain files from those directories.
381
382EXCLUDE_PATTERNS =
383
384# The EXAMPLE_PATH tag can be used to specify one or more files or
385# directories that contain example code fragments that are included (see
386# the \include command).
387
388EXAMPLE_PATH = ../pjsip-apps/src/samples ../pjsip-apps/src/pjsua
389
390# If the value of the EXAMPLE_PATH tag contains directories, you can use the
391# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
392# and *.h) to filter out the source-files in the directories. If left
393# blank all files are included.
394
395EXAMPLE_PATTERNS =
396
397# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
398# searched for input files to be used with the \include or \dontinclude
399# commands irrespective of the value of the RECURSIVE tag.
400# Possible values are YES and NO. If left blank NO is used.
401
402EXAMPLE_RECURSIVE = NO
403
404# The IMAGE_PATH tag can be used to specify one or more files or
405# directories that contain image that are included in the documentation (see
406# the \image command).
407
408IMAGE_PATH = docs ../pjmedia/docs
409
410# The INPUT_FILTER tag can be used to specify a program that doxygen should
411# invoke to filter for each input file. Doxygen will invoke the filter program
412# by executing (via popen()) the command <filter> <input-file>, where <filter>
413# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
414# input file. Doxygen will then use the output that the filter program writes
415# to standard output.
416
417INPUT_FILTER =
418
419# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
420# INPUT_FILTER) will be used to filter the input files when producing source
421# files to browse (i.e. when SOURCE_BROWSER is set to YES).
422
423FILTER_SOURCE_FILES = NO
424
425#---------------------------------------------------------------------------
426# configuration options related to source browsing
427#---------------------------------------------------------------------------
428
429# If the SOURCE_BROWSER tag is set to YES then a list of source files will
430# be generated. Documented entities will be cross-referenced with these sources.
431
432SOURCE_BROWSER = NO
433
434# Setting the INLINE_SOURCES tag to YES will include the body
435# of functions and classes directly in the documentation.
436
437INLINE_SOURCES = NO
438
439# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
440# doxygen to hide any special comment blocks from generated source code
441# fragments. Normal C and C++ comments will always remain visible.
442
443STRIP_CODE_COMMENTS = YES
444
445# If the REFERENCED_BY_RELATION tag is set to YES (the default)
446# then for each documented function all documented
447# functions referencing it will be listed.
448
449REFERENCED_BY_RELATION = YES
450
451# If the REFERENCES_RELATION tag is set to YES (the default)
452# then for each documented function all documented entities
453# called/used by that function will be listed.
454
455REFERENCES_RELATION = YES
456
457#---------------------------------------------------------------------------
458# configuration options related to the alphabetical class index
459#---------------------------------------------------------------------------
460
461# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
462# of all compounds will be generated. Enable this if the project
463# contains a lot of classes, structs, unions or interfaces.
464
465ALPHABETICAL_INDEX = NO
466
467# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
468# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
469# in which this list will be split (can be a number in the range [1..20])
470
471COLS_IN_ALPHA_INDEX = 5
472
473# In case all classes in a project start with a common prefix, all
474# classes will be put under the same header in the alphabetical index.
475# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
476# should be ignored while generating the index headers.
477
478IGNORE_PREFIX = /c/project/pjproject/pjsip
479
480#---------------------------------------------------------------------------
481# configuration options related to the HTML output
482#---------------------------------------------------------------------------
483
484# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
485# generate HTML output.
486
487GENERATE_HTML = YES
488
489# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
490# If a relative path is entered the value of OUTPUT_DIRECTORY will be
491# put in front of it. If left blank `html' will be used as the default path.
492
493HTML_OUTPUT = html
494
495# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
496# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
497# doxygen will generate files with .html extension.
498
499HTML_FILE_EXTENSION = .htm
500
501# The HTML_HEADER tag can be used to specify a personal HTML header for
502# each generated HTML page. If it is left blank doxygen will generate a
503# standard header.
504
505HTML_HEADER = docs/header.html
506
507# The HTML_FOOTER tag can be used to specify a personal HTML footer for
508# each generated HTML page. If it is left blank doxygen will generate a
509# standard footer.
510
511HTML_FOOTER = docs/footer.html
512
513# The HTML_STYLESHEET tag can be used to specify a user defined cascading
514# style sheet that is used by each HTML page. It can be used to
515# fine-tune the look of the HTML output. If the tag is left blank doxygen
516# will generate a default style sheet
517
518HTML_STYLESHEET =
519
520# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
521# files or namespaces will be aligned in HTML using tables. If set to
522# NO a bullet list will be used.
523
524HTML_ALIGN_MEMBERS = YES
525
526# If the GENERATE_HTMLHELP tag is set to YES, additional index files
527# will be generated that can be used as input for tools like the
528# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
529# of the generated HTML documentation.
530
531GENERATE_HTMLHELP = NO
532
533# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
534# be used to specify the file name of the resulting .chm file. You
535# can add a path in front of the file if the result should not be
536# written to the html output dir.
537
538CHM_FILE =
539
540# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
541# be used to specify the location (absolute path including file name) of
542# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
543# the html help compiler on the generated index.hhp.
544
545HHC_LOCATION =
546
547# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
548# controls if a separate .chi index file is generated (YES) or that
549# it should be included in the master .chm file (NO).
550
551GENERATE_CHI = NO
552
553# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
554# controls whether a binary table of contents is generated (YES) or a
555# normal table of contents (NO) in the .chm file.
556
557BINARY_TOC = NO
558
559# The TOC_EXPAND flag can be set to YES to add extra items for group members
560# to the contents of the Html help documentation and to the tree view.
561
562TOC_EXPAND = NO
563
564# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
565# top of each HTML page. The value NO (the default) enables the index and
566# the value YES disables it.
567
568DISABLE_INDEX = NO
569
570# This tag can be used to set the number of enum values (range [1..20])
571# that doxygen will group on one line in the generated HTML documentation.
572
573ENUM_VALUES_PER_LINE = 4
574
575# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
576# generated containing a tree-like index structure (just like the one that
577# is generated for HTML Help). For this to work a browser that supports
578# JavaScript, DHTML, CSS and frames is required (for instance Mozilla,
579# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
580# probably better off using the HTML help feature.
581
582GENERATE_TREEVIEW = NO
583
584# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
585# used to set the initial width (in pixels) of the frame in which the tree
586# is shown.
587
588TREEVIEW_WIDTH = 250
589
590#---------------------------------------------------------------------------
591# configuration options related to the LaTeX output
592#---------------------------------------------------------------------------
593
594# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
595# generate Latex output.
596
597GENERATE_LATEX = NO
598
599# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
600# If a relative path is entered the value of OUTPUT_DIRECTORY will be
601# put in front of it. If left blank `latex' will be used as the default path.
602
603LATEX_OUTPUT = latex
604
605# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
606# invoked. If left blank `latex' will be used as the default command name.
607
608LATEX_CMD_NAME = latex
609
610# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
611# generate index for LaTeX. If left blank `makeindex' will be used as the
612# default command name.
613
614MAKEINDEX_CMD_NAME = makeindex
615
616# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
617# LaTeX documents. This may be useful for small projects and may help to
618# save some trees in general.
619
620COMPACT_LATEX = NO
621
622# The PAPER_TYPE tag can be used to set the paper type that is used
623# by the printer. Possible values are: a4, a4wide, letter, legal and
624# executive. If left blank a4wide will be used.
625
626PAPER_TYPE = a4wide
627
628# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
629# packages that should be included in the LaTeX output.
630
631EXTRA_PACKAGES =
632
633# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
634# the generated latex document. The header should contain everything until
635# the first chapter. If it is left blank doxygen will generate a
636# standard header. Notice: only use this tag if you know what you are doing!
637
638LATEX_HEADER =
639
640# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
641# is prepared for conversion to pdf (using ps2pdf). The pdf file will
642# contain links (just like the HTML output) instead of page references
643# This makes the output suitable for online browsing using a pdf viewer.
644
645PDF_HYPERLINKS = NO
646
647# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
648# plain latex in the generated Makefile. Set this option to YES to get a
649# higher quality PDF documentation.
650
651USE_PDFLATEX = NO
652
653# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
654# command to the generated LaTeX files. This will instruct LaTeX to keep
655# running if errors occur, instead of asking the user for help.
656# This option is also used when generating formulas in HTML.
657
658LATEX_BATCHMODE = NO
659
660#---------------------------------------------------------------------------
661# configuration options related to the RTF output
662#---------------------------------------------------------------------------
663
664# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
665# The RTF output is optimised for Word 97 and may not look very pretty with
666# other RTF readers or editors.
667
668GENERATE_RTF = NO
669
670# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
671# If a relative path is entered the value of OUTPUT_DIRECTORY will be
672# put in front of it. If left blank `rtf' will be used as the default path.
673
674RTF_OUTPUT = rtf
675
676# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
677# RTF documents. This may be useful for small projects and may help to
678# save some trees in general.
679
680COMPACT_RTF = NO
681
682# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
683# will contain hyperlink fields. The RTF file will
684# contain links (just like the HTML output) instead of page references.
685# This makes the output suitable for online browsing using WORD or other
686# programs which support those fields.
687# Note: wordpad (write) and others do not support links.
688
689RTF_HYPERLINKS = NO
690
691# Load stylesheet definitions from file. Syntax is similar to doxygen's
692# config file, i.e. a series of assigments. You only have to provide
693# replacements, missing definitions are set to their default value.
694
695RTF_STYLESHEET_FILE =
696
697# Set optional variables used in the generation of an rtf document.
698# Syntax is similar to doxygen's config file.
699
700RTF_EXTENSIONS_FILE =
701
702#---------------------------------------------------------------------------
703# configuration options related to the man page output
704#---------------------------------------------------------------------------
705
706# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
707# generate man pages
708
709GENERATE_MAN = NO
710
711# The MAN_OUTPUT tag is used to specify where the man pages will be put.
712# If a relative path is entered the value of OUTPUT_DIRECTORY will be
713# put in front of it. If left blank `man' will be used as the default path.
714
715MAN_OUTPUT = man
716
717# The MAN_EXTENSION tag determines the extension that is added to
718# the generated man pages (default is the subroutine's section .3)
719
720MAN_EXTENSION = .3
721
722# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
723# then it will generate one additional man file for each entity
724# documented in the real man page(s). These additional files
725# only source the real man page, but without them the man command
726# would be unable to find the correct page. The default is NO.
727
728MAN_LINKS = NO
729
730#---------------------------------------------------------------------------
731# configuration options related to the XML output
732#---------------------------------------------------------------------------
733
734# If the GENERATE_XML tag is set to YES Doxygen will
735# generate an XML file that captures the structure of
736# the code including all documentation. Note that this
737# feature is still experimental and incomplete at the
738# moment.
739
740GENERATE_XML = NO
741
742# The XML_SCHEMA tag can be used to specify an XML schema,
743# which can be used by a validating XML parser to check the
744# syntax of the XML files.
745
746XML_SCHEMA =
747
748# The XML_DTD tag can be used to specify an XML DTD,
749# which can be used by a validating XML parser to check the
750# syntax of the XML files.
751
752XML_DTD =
753
754#---------------------------------------------------------------------------
755# configuration options for the AutoGen Definitions output
756#---------------------------------------------------------------------------
757
758# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
759# generate an AutoGen Definitions (see autogen.sf.net) file
760# that captures the structure of the code including all
761# documentation. Note that this feature is still experimental
762# and incomplete at the moment.
763
764GENERATE_AUTOGEN_DEF = NO
765
766#---------------------------------------------------------------------------
767# configuration options related to the Perl module output
768#---------------------------------------------------------------------------
769
770# If the GENERATE_PERLMOD tag is set to YES Doxygen will
771# generate a Perl module file that captures the structure of
772# the code including all documentation. Note that this
773# feature is still experimental and incomplete at the
774# moment.
775
776GENERATE_PERLMOD = NO
777
778# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
779# the necessary Makefile rules, Perl scripts and LaTeX code to be able
780# to generate PDF and DVI output from the Perl module output.
781
782PERLMOD_LATEX = NO
783
784# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
785# nicely formatted so it can be parsed by a human reader. This is useful
786# if you want to understand what is going on. On the other hand, if this
787# tag is set to NO the size of the Perl module output will be much smaller
788# and Perl will parse it just the same.
789
790PERLMOD_PRETTY = YES
791
792# The names of the make variables in the generated doxyrules.make file
793# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
794# This is useful so different doxyrules.make files included by the same
795# Makefile don't overwrite each other's variables.
796
797PERLMOD_MAKEVAR_PREFIX =
798
799#---------------------------------------------------------------------------
800# Configuration options related to the preprocessor
801#---------------------------------------------------------------------------
802
803# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
804# evaluate all C-preprocessor directives found in the sources and include
805# files.
806
807ENABLE_PREPROCESSING = YES
808
809# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
810# names in the source code. If set to NO (the default) only conditional
811# compilation will be performed. Macro expansion can be done in a controlled
812# way by setting EXPAND_ONLY_PREDEF to YES.
813
814MACRO_EXPANSION = YES
815
816# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
817# then the macro expansion is limited to the macros specified with the
818# PREDEFINED and EXPAND_AS_PREDEFINED tags.
819
820EXPAND_ONLY_PREDEF = NO
821
822# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
823# in the INCLUDE_PATH (see below) will be search if a #include is found.
824
825SEARCH_INCLUDES = YES
826
827# The INCLUDE_PATH tag can be used to specify one or more directories that
828# contain include files that are not input files but should be processed by
829# the preprocessor.
830
831INCLUDE_PATH =
832
833# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
834# patterns (like *.h and *.hpp) to filter out the header-files in the
835# directories. If left blank, the patterns specified with FILE_PATTERNS will
836# be used.
837
838INCLUDE_FILE_PATTERNS =
839
840# The PREDEFINED tag can be used to specify one or more macro names that
841# are defined before the preprocessor is started (similar to the -D option of
842# gcc). The argument of the tag is a list of macros of the form: name
843# or name=definition (no spaces). If the definition and the = are
844# omitted =1 is assumed.
845
846
847PREDEFINED = PJ_DECL(x)=x PJ_DEF(x)=x PJ_IDECL(x)=x \
848 PJ_IDEF(x)=x PJ_INLINE(x)=x PJ_DECL_DATA(x)=x \
849 PJMEDIA_HAS_SRTP=1 \
850 PJMEDIA_STREAM_ENABLE_KA=1
851
852
853# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
854# this tag can be used to specify a list of macro names that should be expanded.
855# The macro definition that is found in the sources will be used.
856# Use the PREDEFINED tag if you want to use a different macro definition.
857
858EXPAND_AS_DEFINED =
859
860# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
861# doxygen's preprocessor will remove all function-like macros that are alone
862# on a line, have an all uppercase name, and do not end with a semicolon. Such
863# function macros are typically used for boiler-plate code, and will confuse the
864# parser if not removed.
865
866SKIP_FUNCTION_MACROS = YES
867
868#---------------------------------------------------------------------------
869# Configuration::addtions related to external references
870#---------------------------------------------------------------------------
871
872# The TAGFILES tag can be used to specify one or more tagfiles.
873
874TAGFILES = ../pjlib/docs/pjlib.tag=../../../pjlib/docs/html ../pjlib-util/docs/pjlib-util.tag=../../../pjlib-util/docs/html ../pjnath/docs/pjnath.tag=../../../pjnath/docs/html ../pjmedia/docs/pjmedia.tag=../../../pjmedia/docs/html
875
876# When a file name is specified after GENERATE_TAGFILE, doxygen will create
877# a tag file that is based on the input files it reads.
878
879GENERATE_TAGFILE = docs/pjsip.tag
880
881# If the ALLEXTERNALS tag is set to YES all external classes will be listed
882# in the class index. If set to NO only the inherited external classes
883# will be listed.
884
885ALLEXTERNALS = NO
886
887# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
888# in the modules index. If set to NO, only the current project's groups will
889# be listed.
890
891EXTERNAL_GROUPS = NO
892
893# The PERL_PATH should be the absolute path and name of the perl script
894# interpreter (i.e. the result of `which perl').
895
896#PERL_PATH = /usr/bin/perl
897PERL_PATH = /c/Perl/bin/perl
898
899#---------------------------------------------------------------------------
900# Configuration options related to the dot tool
901#---------------------------------------------------------------------------
902
903# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
904# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
905# super classes. Setting the tag to NO turns the diagrams off. Note that this
906# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
907# recommended to install and use dot, since it yield more powerful graphs.
908
909CLASS_DIAGRAMS = YES
910
911# If set to YES, the inheritance and collaboration graphs will hide
912# inheritance and usage relations if the target is undocumented
913# or is not a class.
914
915HIDE_UNDOC_RELATIONS = YES
916
917# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
918# available from the path. This tool is part of Graphviz, a graph visualization
919# toolkit from AT&T and Lucent Bell Labs. The other options in this section
920# have no effect if this option is set to NO (the default)
921
922HAVE_DOT = NO
923
924# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
925# will generate a graph for each documented class showing the direct and
926# indirect inheritance relations. Setting this tag to YES will force the
927# the CLASS_DIAGRAMS tag to NO.
928
929CLASS_GRAPH = YES
930
931# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
932# will generate a graph for each documented class showing the direct and
933# indirect implementation dependencies (inheritance, containment, and
934# class references variables) of the class with other documented classes.
935
936COLLABORATION_GRAPH = YES
937
938# If set to YES, the inheritance and collaboration graphs will show the
939# relations between templates and their instances.
940
941TEMPLATE_RELATIONS = YES
942
943# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
944# tags are set to YES then doxygen will generate a graph for each documented
945# file showing the direct and indirect include dependencies of the file with
946# other documented files.
947
948INCLUDE_GRAPH = YES
949
950# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
951# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
952# documented header file showing the documented files that directly or
953# indirectly include this file.
954
955INCLUDED_BY_GRAPH = YES
956
957# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
958# will graphical hierarchy of all classes instead of a textual one.
959
960GRAPHICAL_HIERARCHY = YES
961
962# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
963# generated by dot. Possible values are png, jpg, or gif
964# If left blank png will be used.
965
966DOT_IMAGE_FORMAT = png
967
968# The tag DOT_PATH can be used to specify the path where the dot tool can be
969# found. If left blank, it is assumed the dot tool can be found on the path.
970
971DOT_PATH =
972
973# The DOTFILE_DIRS tag can be used to specify one or more directories that
974# contain dot files that are included in the documentation (see the
975# \dotfile command).
976
977DOTFILE_DIRS =
978
979# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
980# (in pixels) of the graphs generated by dot. If a graph becomes larger than
981# this value, doxygen will try to truncate the graph, so that it fits within
982# the specified constraint. Beware that most browsers cannot cope with very
983# large images.
984
985MAX_DOT_GRAPH_WIDTH = 1024
986
987# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
988# (in pixels) of the graphs generated by dot. If a graph becomes larger than
989# this value, doxygen will try to truncate the graph, so that it fits within
990# the specified constraint. Beware that most browsers cannot cope with very
991# large images.
992
993MAX_DOT_GRAPH_HEIGHT = 1024
994
995# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
996# generate a legend page explaining the meaning of the various boxes and
997# arrows in the dot generated graphs.
998
999GENERATE_LEGEND = YES
1000
1001# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1002# remove the intermedate dot files that are used to generate
1003# the various graphs.
1004
1005DOT_CLEANUP = YES
1006
1007#---------------------------------------------------------------------------
1008# Configuration::addtions related to the search engine
1009#---------------------------------------------------------------------------
1010
1011# The SEARCHENGINE tag specifies whether or not a search engine should be
1012# used. If set to NO the values of all tags below this one will be ignored.
1013
1014SEARCHENGINE = NO
1015