root/juggler/branches/2.2/modules/sonix/doc/sonix_internal.doxy

Revision 11119, 4.8 kB (checked in by patrickh, 6 years ago)

Sync up with all the other Juggler Project Doxygen settings.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 # Doxyfile 1.2.4
2
3 # This file describes the settings to be used by doxygen for a project
4 #
5 # All text after a hash (#) is considered a comment and will be ignored
6 # The format is:
7 #       TAG = value [value, ...]
8 # For lists items can also be appended using:
9 #       TAG += value [value, ...]
10 # Values that contain spaces should be placed between quotes (" ")
11
12 # Include default values
13 @INCLUDE = sonix.doxy
14
15 #---------------------------------------------------------------------------
16 # General configuration options
17 #---------------------------------------------------------------------------
18
19 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
20 # by quotes) that should identify the project.
21
22 PROJECT_NAME           = "Juggler Sonix [Internal Docs]"
23
24 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
25 # base path where the generated documentation will be put.
26 # If a relative path is entered, it will be relative to the location
27 # where doxygen was started. If left blank the current directory will be used.
28
29 OUTPUT_DIRECTORY       = internal
30
31 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
32 # will be included in the documentation.
33
34 EXTRACT_PRIVATE        = YES
35
36 # The INTERNAL_DOCS tag determines if documentation
37 # that is typed after a \internal command is included. If the tag is set
38 # to NO (the default) then the documentation will be excluded.
39 # Set it to YES to include the internal documentation.
40
41 INTERNAL_DOCS          = YES
42
43 # Setting the INLINE_SOURCES tag to YES will include the body
44 # of functions and classes directly in the documentation.
45
46 INLINE_SOURCES         = YES
47
48 #---------------------------------------------------------------------------
49 # configuration options related to warning and progress messages
50 #---------------------------------------------------------------------------
51
52 #---------------------------------------------------------------------------
53 # configuration options related to the input files
54 #---------------------------------------------------------------------------
55 #---------------------------------------------------------------------------
56 # configuration options related to the alphabetical class index
57 #---------------------------------------------------------------------------
58
59 #---------------------------------------------------------------------------
60 # configuration options related to the HTML output
61 #---------------------------------------------------------------------------
62
63 #---------------------------------------------------------------------------
64 # configuration options related to the LaTeX output
65 #---------------------------------------------------------------------------
66
67 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
68 # generate Latex output.
69
70 GENERATE_LATEX         = NO
71
72 #---------------------------------------------------------------------------
73 # configuration options related to the RTF output
74 #---------------------------------------------------------------------------
75
76 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
77 # The RTF output is optimised for Word 97 and may not look very pretty with
78 # other RTF readers or editors.
79
80 GENERATE_RTF           = NO
81
82 #---------------------------------------------------------------------------
83 # configuration options related to the man page output
84 #---------------------------------------------------------------------------
85 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
86 # generate man pages
87
88 GENERATE_MAN           = NO
89
90 #---------------------------------------------------------------------------
91 # configuration options related to the XML output
92 #---------------------------------------------------------------------------
93
94 # If the GENERATE_XML tag is set to YES Doxygen will
95 # generate an XML file that captures the structure of
96 # the code including all documentation. Warning: This feature
97 # is still experimental and very incomplete.
98
99 GENERATE_XML           = NO
100
101 #---------------------------------------------------------------------------
102 # Configuration options related to the preprocessor   
103 #---------------------------------------------------------------------------
104
105
106 #---------------------------------------------------------------------------
107 # Configuration::addtions related to external references   
108 #---------------------------------------------------------------------------
109
110 #---------------------------------------------------------------------------
111 # Configuration options related to the dot tool   
112 #---------------------------------------------------------------------------
113
114 #---------------------------------------------------------------------------
115 # Configuration::addtions related to the search engine   
116 #---------------------------------------------------------------------------
Note: See TracBrowser for help on using the browser.