source: tags/release-1.1.7/duchamp.dox

Last change on this file was 528, checked in by MatthewWhiting, 15 years ago

Changing the documentation comments to match the askapsoft style. Also have split ChanMap? and Object3D into separate files.
File size: 8.8 KB
Line 
1# Doxyfile 1.5.1
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME           = Duchamp
7PROJECT_NUMBER         = 1.1.7
8OUTPUT_DIRECTORY       = docs
9CREATE_SUBDIRS         = NO
10OUTPUT_LANGUAGE        = English
11USE_WINDOWS_ENCODING   = NO
12BRIEF_MEMBER_DESC      = YES
13REPEAT_BRIEF           = YES
14ABBREVIATE_BRIEF       = "The $name class" \
15                         "The $name widget" \
16                         "The $name file" \
17                         is \
18                         provides \
19                         specifies \
20                         contains \
21                         represents \
22                         a \
23                         an \
24                         the
25ALWAYS_DETAILED_SEC    = NO
26INLINE_INHERITED_MEMB  = NO
27FULL_PATH_NAMES        = YES
28STRIP_FROM_PATH        = /Applications/
29STRIP_FROM_INC_PATH    =
30SHORT_NAMES            = NO
31JAVADOC_AUTOBRIEF      = NO
32MULTILINE_CPP_IS_BRIEF = NO
33DETAILS_AT_TOP         = NO
34INHERIT_DOCS           = YES
35SEPARATE_MEMBER_PAGES  = NO
36TAB_SIZE               = 8
37ALIASES                =
38OPTIMIZE_OUTPUT_FOR_C  = NO
39OPTIMIZE_OUTPUT_JAVA   = NO
40BUILTIN_STL_SUPPORT    = NO
41DISTRIBUTE_GROUP_DOC   = NO
42SUBGROUPING            = YES
43#---------------------------------------------------------------------------
44# Build related configuration options
45#---------------------------------------------------------------------------
46EXTRACT_ALL            = NO
47EXTRACT_PRIVATE        = NO
48EXTRACT_STATIC         = NO
49EXTRACT_LOCAL_CLASSES  = YES
50EXTRACT_LOCAL_METHODS  = NO
51HIDE_UNDOC_MEMBERS     = YES
52HIDE_UNDOC_CLASSES     = YES
53HIDE_FRIEND_COMPOUNDS  = NO
54HIDE_IN_BODY_DOCS      = NO
55INTERNAL_DOCS          = NO
56CASE_SENSE_NAMES       = NO
57HIDE_SCOPE_NAMES       = NO
58SHOW_INCLUDE_FILES     = YES
59INLINE_INFO            = YES
60SORT_MEMBER_DOCS       = YES
61SORT_BRIEF_DOCS        = NO
62SORT_BY_SCOPE_NAME     = NO
63GENERATE_TODOLIST      = YES
64GENERATE_TESTLIST      = YES
65GENERATE_BUGLIST       = YES
66GENERATE_DEPRECATEDLIST= YES
67ENABLED_SECTIONS       =
68MAX_INITIALIZER_LINES  = 30
69SHOW_USED_FILES        = YES
70SHOW_DIRECTORIES       = NO
71FILE_VERSION_FILTER    =
72#---------------------------------------------------------------------------
73# configuration options related to warning and progress messages
74#---------------------------------------------------------------------------
75QUIET                  = NO
76WARNINGS               = YES
77WARN_IF_UNDOCUMENTED   = YES
78WARN_IF_DOC_ERROR      = YES
79WARN_NO_PARAMDOC       = NO
80WARN_FORMAT            = "$file:$line: $text"
81WARN_LOGFILE           =
82#---------------------------------------------------------------------------
83# configuration options related to the input files
84#---------------------------------------------------------------------------
85INPUT                  = docs/duchampPackage.dox src src/ATrous src/Cubes src/Detection src/FitsIO src/PixelMap src/Utils
86FILE_PATTERNS          = *.c \
87                         *.cc \
88                         *.h \
89                         *.hh
90RECURSIVE              = NO
91EXCLUDE                =
92EXCLUDE_SYMLINKS       = NO
93EXCLUDE_PATTERNS       =
94EXAMPLE_PATH           =
95EXAMPLE_PATTERNS       = *
96EXAMPLE_RECURSIVE      = NO
97IMAGE_PATH             =
98INPUT_FILTER           =
99FILTER_PATTERNS        =
100FILTER_SOURCE_FILES    = NO
101#---------------------------------------------------------------------------
102# configuration options related to source browsing
103#---------------------------------------------------------------------------
104SOURCE_BROWSER         = YES
105INLINE_SOURCES         = NO
106STRIP_CODE_COMMENTS    = YES
107REFERENCED_BY_RELATION = YES
108REFERENCES_RELATION    = YES
109REFERENCES_LINK_SOURCE = YES
110USE_HTAGS              = NO
111VERBATIM_HEADERS       = YES
112#---------------------------------------------------------------------------
113# configuration options related to the alphabetical class index
114#---------------------------------------------------------------------------
115ALPHABETICAL_INDEX     = NO
116COLS_IN_ALPHA_INDEX    = 5
117IGNORE_PREFIX          =
118#---------------------------------------------------------------------------
119# configuration options related to the HTML output
120#---------------------------------------------------------------------------
121GENERATE_HTML          = YES
122HTML_OUTPUT            = html
123HTML_FILE_EXTENSION    = .html
124HTML_HEADER            =
125HTML_FOOTER            =
126HTML_STYLESHEET        =
127HTML_ALIGN_MEMBERS     = YES
128GENERATE_HTMLHELP      = NO
129CHM_FILE               =
130HHC_LOCATION           =
131GENERATE_CHI           = NO
132BINARY_TOC             = NO
133TOC_EXPAND             = NO
134DISABLE_INDEX          = NO
135ENUM_VALUES_PER_LINE   = 4
136GENERATE_TREEVIEW      = NO
137TREEVIEW_WIDTH         = 250
138#---------------------------------------------------------------------------
139# configuration options related to the LaTeX output
140#---------------------------------------------------------------------------
141GENERATE_LATEX         = YES
142LATEX_OUTPUT           = latex
143LATEX_CMD_NAME         = latex
144MAKEINDEX_CMD_NAME     = makeindex
145COMPACT_LATEX          = NO
146PAPER_TYPE             = a4wide
147EXTRA_PACKAGES         =
148LATEX_HEADER           =
149PDF_HYPERLINKS         = YES
150USE_PDFLATEX           = YES
151LATEX_BATCHMODE        = NO
152LATEX_HIDE_INDICES     = NO
153#---------------------------------------------------------------------------
154# configuration options related to the RTF output
155#---------------------------------------------------------------------------
156GENERATE_RTF           = NO
157RTF_OUTPUT             = rtf
158COMPACT_RTF            = NO
159RTF_HYPERLINKS         = NO
160RTF_STYLESHEET_FILE    =
161RTF_EXTENSIONS_FILE    =
162#---------------------------------------------------------------------------
163# configuration options related to the man page output
164#---------------------------------------------------------------------------
165GENERATE_MAN           = NO
166MAN_OUTPUT             = man
167MAN_EXTENSION          = .3
168MAN_LINKS              = NO
169#---------------------------------------------------------------------------
170# configuration options related to the XML output
171#---------------------------------------------------------------------------
172GENERATE_XML           = NO
173XML_OUTPUT             = xml
174XML_SCHEMA             =
175XML_DTD                =
176XML_PROGRAMLISTING     = YES
177#---------------------------------------------------------------------------
178# configuration options for the AutoGen Definitions output
179#---------------------------------------------------------------------------
180GENERATE_AUTOGEN_DEF   = NO
181#---------------------------------------------------------------------------
182# configuration options related to the Perl module output
183#---------------------------------------------------------------------------
184GENERATE_PERLMOD       = NO
185PERLMOD_LATEX          = NO
186PERLMOD_PRETTY         = YES
187PERLMOD_MAKEVAR_PREFIX =
188#---------------------------------------------------------------------------
189# Configuration options related to the preprocessor   
190#---------------------------------------------------------------------------
191ENABLE_PREPROCESSING   = YES
192MACRO_EXPANSION        = NO
193EXPAND_ONLY_PREDEF     = NO
194SEARCH_INCLUDES        = YES
195INCLUDE_PATH           =
196INCLUDE_FILE_PATTERNS  =
197PREDEFINED             =
198EXPAND_AS_DEFINED      =
199SKIP_FUNCTION_MACROS   = YES
200#---------------------------------------------------------------------------
201# Configuration::additions related to external references   
202#---------------------------------------------------------------------------
203TAGFILES               =
204GENERATE_TAGFILE       =
205ALLEXTERNALS           = NO
206EXTERNAL_GROUPS        = YES
207PERL_PATH              = /usr/bin/perl
208#---------------------------------------------------------------------------
209# Configuration options related to the dot tool   
210#---------------------------------------------------------------------------
211CLASS_DIAGRAMS         = NO
212HIDE_UNDOC_RELATIONS   = YES
213HAVE_DOT               = YES
214CLASS_GRAPH            = YES
215COLLABORATION_GRAPH    = YES
216GROUP_GRAPHS           = YES
217UML_LOOK               = NO
218TEMPLATE_RELATIONS     = NO
219INCLUDE_GRAPH          = YES
220INCLUDED_BY_GRAPH      = YES
221CALL_GRAPH             = NO
222CALLER_GRAPH           = NO
223GRAPHICAL_HIERARCHY    = YES
224DIRECTORY_GRAPH        = YES
225DOT_IMAGE_FORMAT       = png
226DOT_PATH               = /Applications/Doxygen.app/Contents/Resources/
227DOTFILE_DIRS           =
228MAX_DOT_GRAPH_WIDTH    = 1024
229MAX_DOT_GRAPH_HEIGHT   = 1024
230MAX_DOT_GRAPH_DEPTH    = 1000
231DOT_TRANSPARENT        = NO
232DOT_MULTI_TARGETS      = NO
233GENERATE_LEGEND        = YES
234DOT_CLEANUP            = YES
235#---------------------------------------------------------------------------
236# Configuration::additions related to the search engine   
237#---------------------------------------------------------------------------
238SEARCHENGINE           = NO
Note: See TracBrowser for help on using the repository browser.