c_nifti 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +37 -0
  3. data/.rspec +2 -0
  4. data/.ruby-gemset +1 -0
  5. data/.ruby-version +1 -0
  6. data/COPYING +621 -0
  7. data/COPYING.lesser +166 -0
  8. data/Gemfile +4 -0
  9. data/README.md +117 -0
  10. data/Rakefile +6 -0
  11. data/c_nifti.gemspec +31 -0
  12. data/ext/nifticlib/extconf.rb +30 -0
  13. data/ext/nifticlib/include/nifti_image.h +2 -0
  14. data/ext/nifticlib/include/nifti_image_converters.h +3 -0
  15. data/ext/nifticlib/include/nifti_image_dimensions.h +1 -0
  16. data/ext/nifticlib/include/nifti_image_intents.h +1 -0
  17. data/ext/nifticlib/include/nifti_image_metadata.h +1 -0
  18. data/ext/nifticlib/include/nifti_image_quaternions.h +1 -0
  19. data/ext/nifticlib/include/nifti_image_spacings.h +1 -0
  20. data/ext/nifticlib/include/nifti_image_timings.h +1 -0
  21. data/ext/nifticlib/include/nifti_image_transforms.h +1 -0
  22. data/ext/nifticlib/nifti_image.c +169 -0
  23. data/ext/nifticlib/nifti_image_converters.c +65 -0
  24. data/ext/nifticlib/nifti_image_dimensions.c +113 -0
  25. data/ext/nifticlib/nifti_image_intents.c +45 -0
  26. data/ext/nifticlib/nifti_image_metadata.c +133 -0
  27. data/ext/nifticlib/nifti_image_quaternions.c +59 -0
  28. data/ext/nifticlib/nifti_image_spacings.c +87 -0
  29. data/ext/nifticlib/nifti_image_timings.c +66 -0
  30. data/ext/nifticlib/nifti_image_transforms.c +38 -0
  31. data/ext/nifticlib/nifticlib-2.0.0/CMakeLists.txt +140 -0
  32. data/ext/nifticlib/nifticlib-2.0.0/CTestConfig.cmake +13 -0
  33. data/ext/nifticlib/nifticlib-2.0.0/LICENSE +9 -0
  34. data/ext/nifticlib/nifticlib-2.0.0/Makefile +265 -0
  35. data/ext/nifticlib/nifticlib-2.0.0/Makefile.cross_mingw32 +94 -0
  36. data/ext/nifticlib/nifticlib-2.0.0/README +79 -0
  37. data/ext/nifticlib/nifticlib-2.0.0/Testing/CMakeLists.txt +7 -0
  38. data/ext/nifticlib/nifticlib-2.0.0/Testing/Data/ATestReferenceImageForReadingAndWriting.nii.gz +0 -0
  39. data/ext/nifticlib/nifticlib-2.0.0/Testing/Makefile +21 -0
  40. data/ext/nifticlib/nifticlib-2.0.0/Testing/README_regress +50 -0
  41. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/@show.diffs +33 -0
  42. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/@test +80 -0
  43. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/CMakeLists.txt +47 -0
  44. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/cmake_testscripts/bricks_test.sh +32 -0
  45. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/cmake_testscripts/comment_test.sh +65 -0
  46. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/cmake_testscripts/dci_test.sh +46 -0
  47. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/cmake_testscripts/dsets_test.sh +61 -0
  48. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/cmake_testscripts/dts_test.sh +75 -0
  49. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/cmake_testscripts/fetch_data_test.sh +45 -0
  50. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/cmake_testscripts/mod_header_test.sh +60 -0
  51. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/cmake_testscripts/newfiles_test.sh +36 -0
  52. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c01.versions +10 -0
  53. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c02.nt.help +5 -0
  54. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c03.hist +5 -0
  55. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c04.disp.anat0.info +7 -0
  56. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c05.mod.hdr +9 -0
  57. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c06.add.ext +22 -0
  58. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c07.cbl.4bricks +8 -0
  59. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c08.dts.19.36.11 +4 -0
  60. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c09.dts4.compare +9 -0
  61. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c10.dci.ts4 +15 -0
  62. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c10a.dci.run.210 +16 -0
  63. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c11.add.comment +8 -0
  64. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c12.check.comments +7 -0
  65. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c13.check.hdrs +5 -0
  66. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c14.make.dsets +21 -0
  67. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c15.new.files +21 -0
  68. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c16.rand.swap +35 -0
  69. data/ext/nifticlib/nifticlib-2.0.0/Testing/nifti_regress_test/commands/c17.file.case +34 -0
  70. data/ext/nifticlib/nifticlib-2.0.0/Testing/niftilib/CMakeLists.txt +15 -0
  71. data/ext/nifticlib/nifticlib-2.0.0/Testing/niftilib/nifti_test.c +690 -0
  72. data/ext/nifticlib/nifticlib-2.0.0/Testing/niftilib/nifti_test2.c +32 -0
  73. data/ext/nifticlib/nifticlib-2.0.0/Updates.txt +110 -0
  74. data/ext/nifticlib/nifticlib-2.0.0/bin/.gitkeep +0 -0
  75. data/ext/nifticlib/nifticlib-2.0.0/docs/Doxy_nifti.txt +123 -0
  76. data/ext/nifticlib/nifticlib-2.0.0/docs/Doxyfile.ORIG +746 -0
  77. data/ext/nifticlib/nifticlib-2.0.0/examples/CMakeLists.txt +15 -0
  78. data/ext/nifticlib/nifticlib-2.0.0/examples/Makefile +48 -0
  79. data/ext/nifticlib/nifticlib-2.0.0/examples/clib_01_read_write.c +94 -0
  80. data/ext/nifticlib/nifticlib-2.0.0/examples/fsl_api_driver.c +142 -0
  81. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/CMakeLists.txt +32 -0
  82. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/Makefile +29 -0
  83. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/fslio.c +2426 -0
  84. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/fslio.tcl +83 -0
  85. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/imcp +65 -0
  86. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/imglob +59 -0
  87. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/imln +37 -0
  88. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/immv +64 -0
  89. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/imrm +29 -0
  90. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/imtest +53 -0
  91. data/ext/nifticlib/nifticlib-2.0.0/fsliolib/remove_ext +33 -0
  92. data/ext/nifticlib/nifticlib-2.0.0/include/.gitkeep +0 -0
  93. data/ext/nifticlib/nifticlib-2.0.0/nifticdf/CMakeLists.txt +28 -0
  94. data/ext/nifticlib/nifticlib-2.0.0/nifticdf/Makefile +28 -0
  95. data/ext/nifticlib/nifticlib-2.0.0/nifticdf/nifticdf.c +11107 -0
  96. data/ext/nifticlib/nifticlib-2.0.0/niftilib/CMakeLists.txt +33 -0
  97. data/ext/nifticlib/nifticlib-2.0.0/niftilib/Makefile +31 -0
  98. data/ext/nifticlib/nifticlib-2.0.0/niftilib/nifti1_io.c +7509 -0
  99. data/ext/nifticlib/nifticlib-2.0.0/packaging/DevPackage.template +18 -0
  100. data/ext/nifticlib/nifticlib-2.0.0/packaging/nifticlib.spec +62 -0
  101. data/ext/nifticlib/nifticlib-2.0.0/real_easy/nifti1_read_write.c +361 -0
  102. data/ext/nifticlib/nifticlib-2.0.0/utils/CMakeLists.txt +73 -0
  103. data/ext/nifticlib/nifticlib-2.0.0/utils/Makefile +55 -0
  104. data/ext/nifticlib/nifticlib-2.0.0/utils/nifti1_test.c +95 -0
  105. data/ext/nifticlib/nifticlib-2.0.0/utils/nifti_stats.c +95 -0
  106. data/ext/nifticlib/nifticlib-2.0.0/utils/nifti_tool.c +4193 -0
  107. data/ext/nifticlib/nifticlib-2.0.0/utils/nifti_tool.h +163 -0
  108. data/ext/nifticlib/nifticlib-2.0.0/znzlib/CMakeLists.txt +31 -0
  109. data/ext/nifticlib/nifticlib-2.0.0/znzlib/Makefile +33 -0
  110. data/ext/nifticlib/nifticlib-2.0.0/znzlib/znzlib.c +322 -0
  111. data/ext/nifticlib/nifticlib.c +107 -0
  112. data/ext/nifticlib/patches/nifticlib_fpic.patch +13 -0
  113. data/features/read_modify_write.feature +11 -0
  114. data/features/step_definitions/nifti_image_steps.rb +16 -0
  115. data/features/support/env.rb +14 -0
  116. data/features/support/fixtures/sample.nii.gz +0 -0
  117. data/lib/c_nifti.rb +9 -0
  118. data/lib/c_nifti/data.rb +70 -0
  119. data/lib/c_nifti/header.rb +16 -0
  120. data/lib/c_nifti/header_element.rb +13 -0
  121. data/lib/c_nifti/header_element/datatype.rb +49 -0
  122. data/lib/c_nifti/header_element/datatype/base.rb +9 -0
  123. data/lib/c_nifti/header_element/datatype/binary.rb +11 -0
  124. data/lib/c_nifti/header_element/datatype/double.rb +11 -0
  125. data/lib/c_nifti/header_element/datatype/float.rb +11 -0
  126. data/lib/c_nifti/header_element/datatype/long_double.rb +11 -0
  127. data/lib/c_nifti/header_element/datatype/long_long.rb +11 -0
  128. data/lib/c_nifti/header_element/datatype/signed_char.rb +11 -0
  129. data/lib/c_nifti/header_element/datatype/signed_int.rb +11 -0
  130. data/lib/c_nifti/header_element/datatype/signed_short.rb +11 -0
  131. data/lib/c_nifti/header_element/datatype/unsigned_char.rb +11 -0
  132. data/lib/c_nifti/header_element/datatype/unsigned_int.rb +11 -0
  133. data/lib/c_nifti/header_element/datatype/unsigned_long_long.rb +11 -0
  134. data/lib/c_nifti/header_element/datatype/unsigned_short.rb +11 -0
  135. data/lib/c_nifti/header_element/dimensions.rb +53 -0
  136. data/lib/c_nifti/header_element/intents.rb +25 -0
  137. data/lib/c_nifti/header_element/metadata.rb +49 -0
  138. data/lib/c_nifti/header_element/miscellaneous.rb +25 -0
  139. data/lib/c_nifti/header_element/quaternions.rb +33 -0
  140. data/lib/c_nifti/header_element/spacings.rb +45 -0
  141. data/lib/c_nifti/header_element/timings.rb +37 -0
  142. data/lib/c_nifti/header_element/transforms.rb +21 -0
  143. data/lib/c_nifti/image.rb +31 -0
  144. data/lib/c_nifti/version.rb +3 -0
  145. data/lib/nifticlib.rb +1 -0
  146. data/spec/data_spec.rb +112 -0
  147. data/spec/factories/nifti_images.rb +9 -0
  148. data/spec/header_element/datatype/base_spec.rb +9 -0
  149. data/spec/header_element/datatype/binary_spec.rb +9 -0
  150. data/spec/header_element/datatype/double_spec.rb +9 -0
  151. data/spec/header_element/datatype/float_spec.rb +9 -0
  152. data/spec/header_element/datatype/long_double_spec.rb +9 -0
  153. data/spec/header_element/datatype/long_long_spec.rb +9 -0
  154. data/spec/header_element/datatype/signed_char_spec.rb +9 -0
  155. data/spec/header_element/datatype/signed_int_spec.rb +9 -0
  156. data/spec/header_element/datatype/signed_short_spec.rb +9 -0
  157. data/spec/header_element/datatype/unsigned_char_spec.rb +9 -0
  158. data/spec/header_element/datatype/unsigned_int_spec.rb +9 -0
  159. data/spec/header_element/datatype/unsigned_long_long.rb +9 -0
  160. data/spec/header_element/datatype/unsigned_short_spec.rb +9 -0
  161. data/spec/header_element/datatype_spec.rb +109 -0
  162. data/spec/header_element/dimensions_spec.rb +105 -0
  163. data/spec/header_element/intents_spec.rb +48 -0
  164. data/spec/header_element/metadata_spec.rb +96 -0
  165. data/spec/header_element/miscellaneous_spec.rb +48 -0
  166. data/spec/header_element/quaternions_spec.rb +64 -0
  167. data/spec/header_element/spacings_spec.rb +88 -0
  168. data/spec/header_element/timings_spec.rb +72 -0
  169. data/spec/header_element/transforms_spec.rb +64 -0
  170. data/spec/image_spec.rb +39 -0
  171. data/spec/spec_helper.rb +85 -0
  172. metadata +363 -0
@@ -0,0 +1,32 @@
1
+ /*
2
+ * nifti_test2 -- this exercises a particular bug, whereby nifti_copy_nim_info was
3
+ * not working correctly, which left the copy of an image pointing to the same
4
+ * extension list, which could cause all sorts of grief.
5
+ */
6
+ #include <nifti1_io.h>
7
+ int main (int argc, char *argv[])
8
+ {
9
+ /*
10
+ * create a 'dummy' image
11
+ */
12
+ nifti_image *i1 = nifti_simple_init_nim();
13
+ nifti_image *i2;
14
+
15
+ /*
16
+ * add an extension to the dummy
17
+ */
18
+ static char ext[] = "THIS IS A TEST";
19
+ nifti_add_extension(i1,ext,sizeof(ext),NIFTI_ECODE_COMMENT);
20
+ /*
21
+ * make a new nim from the dummy
22
+ */
23
+ i2 = nifti_copy_nim_info(i1);
24
+ /*
25
+ * if the bug isn't fixed in niftilib, the second nifti_image_free
26
+ * will fail because both nims point to the same extensions. With gcc
27
+ * this will abort inside the standard library
28
+ */
29
+ nifti_image_free(i1);
30
+ nifti_image_free(i2);
31
+ return 0;
32
+ }
@@ -0,0 +1,110 @@
1
+
2
+ Updates to the niftilb C package
3
+
4
+ -----------------------------------------------------------------
5
+ Updates in version 0.3 April 12, 2006
6
+
7
+ - added const in appropriate function parameter locations
8
+ - shortened all string constants below 509 character limit
9
+ - added nifti_is_complete_filename()
10
+ - made minor memory fixes
11
+ - fixed error in QSTR() definition
12
+ - use nifti_set_filenames() in nifti_convert_nhdr2nim()
13
+ - added new tests in Testing/niftilib/nifti_test.c
14
+ - added skip blank extension option to keep 348 byte header
15
+ - when reading, allow 0 or 1 in dim[] fields above dim[0]
16
+ - added more tests to nifti_hdr_looks_good()
17
+ - nifti_tool: added check_hdr and check_nim action options
18
+
19
+ -----------------------------------------------------------------
20
+ Updates in version 0.4 September 6, 2006
21
+
22
+ - for testing, added Testing/Data, Testing/niftilib/nifti_test2.c and
23
+ Testing/Data/ATestReferenceImageForReadingAndWriting.nii.gz
24
+ - modified Testing/niftilib/nifti_test.c for better code coverage
25
+ - added switch for not building unused funcs in nifti_stats.c
26
+ - modified nifti1_io.c: free(hstr) and clear ext vars
27
+ - fixed nt=0 case from 1.17 change in nifti_alloc_NBL_mem()
28
+ - fixed nifti_findhdrname() logic for efirst
29
+ - all fsliolib files: updated header to make public domain clear
30
+ - added nifti_set_skip_blank_ext()
31
+
32
+ -----------------------------------------------------------------
33
+ Updates in version 0.5 May 17, 2007
34
+
35
+ - fixed duplication of incuding utils directory for CMake
36
+ - syncronized with developments in ITK to prepare for building and
37
+ tar/rpm/dmg packaging with new versions of cmake
38
+ - added more typecasting to remove compiler warnings
39
+ - fslio.c: check for NULL return from nifti_image_read()
40
+ - creation of nifticdf directory, to separate cdf library functions
41
+ from utils/nifti_stats.c
42
+ - make system update for nifticdf
43
+ - modified CMakeBuild system to be compliant with new CPACK mechanism
44
+ of generating binary distributions
45
+ - modified CMake system to build shared libraries
46
+ - modified Makefiles to use ARCH in more cases
47
+
48
+ -----------------------------------------------------------------
49
+ Updated in version 0.6 August 27, 2007
50
+
51
+ - RR allowed for datasets with a single volume > 2^31 bytes
52
+ - RR allowed for datasets with total size > 2^32 bytes
53
+ - RR added regression testing under Testing/nifti_regress_test
54
+ - KF added upper level packaging directory and put Andy Loenings's
55
+ rpm spec file in it
56
+ - HJ Changed default installation path of header files into include/nifti
57
+ from CMakeLists.txt
58
+ - HJ/KW Added exposing Analyze75 orientation codes
59
+ - HJ/KW Added function to allow any sized subregion of the image to be read
60
+ from disk
61
+ - RR/KF znzlib/config.h incorporated into znzlib.h and removed
62
+
63
+ -----------------------------------------------------------------
64
+ Updated in version 1.0 December 6, 2007
65
+
66
+ - MH added DevPak packaging template for Dev-Cpp IDE
67
+ - MH added Makefile for cross-compiling for win32 on linux using mingw32
68
+ - Yaroslav/MH/RR fixed ARM struct alignment problem when byte-swapping
69
+ - MH fixed short filename problem in FslFileType
70
+ - RR added RGBA32 type nad NIFTI_ECODE_FREESURFER macros
71
+ - RR added 5 NIFTI_INTENT codes for GIFTI
72
+ - RR added nifti_datatype_to_string and similar functionality
73
+ - MH Simplified CMake configuration to apply same shared library version
74
+ to all libraries.
75
+
76
+ -----------------------------------------------------------------
77
+ Updated in version 1.1.0 August 28, 2008
78
+
79
+ - RR allowed ANALYZE headers in nifti_hdr_looks_good
80
+ - RR added nifti_compiled_with_zlib()
81
+ - RR added nifti_tool ability to add extensions via 'file:FILENAME'
82
+ - RR added new tests to nifti_regress_test/commands
83
+ - RR added ANALYZE 7.5 support for swapping
84
+ - HJ addressed CMake bug listed by ITK at
85
+ http://www.itk.org/Bug/view.php?id=7530
86
+ having to do with ITK version numbers for znzlib.
87
+
88
+
89
+ -----------------------------------------------------------------
90
+ Updated in version 2.0.0 July 20, 2010
91
+
92
+ - RR added nifti_NBL_matches_nim() check for write_bricks()
93
+ - HJ added casts to suppress compiler warnings
94
+ - RR added NIFTI_ECODE_PYPICKLE
95
+ - RR added NIFTI_ECODEs 18-28 for the LONI MiND group
96
+ - RR added examples/clib_01_read_write.c as a simple library example
97
+ - RR allow uppercase extension
98
+ - RR added 4 checks of alloc() returns
99
+ - RR added NIFTI_ECODE_VOXBO for Dan Kimberg of VoxBo
100
+ - RR added NIFTI_ECODE_CARET for John Harwell of Caret
101
+ - RR fixed znzread/write for large files
102
+ - RR changed nifti_swap_* routines/calls to take size_t
103
+ - RR fixed nifti_tool.c:nt_read_bricks bsize for large files
104
+ - MH updated CMakeLists.txt to version 2.0
105
+
106
+
107
+ -----------------------------------------------------------------
108
+ Recent Updates
109
+
110
+
@@ -0,0 +1,123 @@
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
+ #---------------------------------------------------------------------------
13
+ # General configuration options
14
+ #---------------------------------------------------------------------------
15
+
16
+ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
17
+ # by quotes) that should identify the project.
18
+
19
+ PROJECT_NAME = nifti1_io
20
+
21
+
22
+ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
23
+ # base path where the generated documentation will be put.
24
+ # If a relative path is entered, it will be relative to the location
25
+ # where doxygen was started. If left blank the current directory will be used.
26
+
27
+ OUTPUT_DIRECTORY =
28
+
29
+
30
+ #---------------------------------------------------------------------------
31
+ # configuration options related to the input files
32
+ #---------------------------------------------------------------------------
33
+
34
+ # The INPUT tag can be used to specify the files and/or directories that contain
35
+ # documented source files. You may enter file names like "myfile.cpp" or
36
+ # directories like "/usr/src/myproject". Separate the files or directories
37
+ # with spaces.
38
+
39
+ INPUT = ../fsliolib ../niftilib ../znzlib
40
+
41
+ # If the value of the INPUT tag contains directories, you can use the
42
+ # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
43
+ # and *.h) to filter out the source-files in the directories. If left
44
+ # blank all files are included.
45
+
46
+ FILE_PATTERNS = *.c *.h
47
+
48
+ # The RECURSIVE tag can be used to turn specify whether or not subdirectories
49
+ # should be searched for input files as well. Possible values are YES and NO.
50
+ # If left blank NO is used.
51
+
52
+ RECURSIVE = NO
53
+
54
+ # The EXCLUDE tag can be used to specify files and/or directories that should
55
+ # excluded from the INPUT source files. This way you can easily exclude a
56
+ # subdirectory from a directory tree whose root is specified with the INPUT tag.
57
+
58
+ EXCLUDE = testprog.c nifti1_test.c mjtest.c
59
+
60
+ # If the value of the INPUT tag contains directories, you can use the
61
+ # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
62
+ # certain files from those directories.
63
+
64
+ EXCLUDE_PATTERNS =
65
+
66
+
67
+ #---------------------------------------------------------------------------
68
+ # configuration options related to the HTML output
69
+ #---------------------------------------------------------------------------
70
+
71
+ # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
72
+ # generate HTML output.
73
+
74
+ GENERATE_HTML = YES
75
+
76
+ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
77
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
78
+ # put in front of it. If left blank `html' will be used as the default path.
79
+
80
+ HTML_OUTPUT = html
81
+
82
+
83
+ #---------------------------------------------------------------------------
84
+ # configuration options related to the LaTeX output
85
+ #---------------------------------------------------------------------------
86
+
87
+ # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
88
+ # generate Latex output.
89
+
90
+ GENERATE_LATEX = NO
91
+
92
+
93
+ #---------------------------------------------------------------------------
94
+ # configuration options related to the RTF output
95
+ #---------------------------------------------------------------------------
96
+
97
+ # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
98
+ # The RTF output is optimised for Word 97 and may not look very pretty with
99
+ # other RTF readers or editors.
100
+
101
+ GENERATE_RTF = NO
102
+
103
+
104
+ #---------------------------------------------------------------------------
105
+ # configuration options related to the man page output
106
+ #---------------------------------------------------------------------------
107
+
108
+ # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
109
+ # generate man pages
110
+
111
+ GENERATE_MAN = NO
112
+
113
+ #---------------------------------------------------------------------------
114
+ # configuration options related to the XML output
115
+ #---------------------------------------------------------------------------
116
+
117
+ # If the GENERATE_XML tag is set to YES Doxygen will
118
+ # generate an XML file that captures the structure of
119
+ # the code including all documentation. Warning: This feature
120
+ # is still experimental and very incomplete.
121
+
122
+ GENERATE_XML = NO
123
+
@@ -0,0 +1,746 @@
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
+ #---------------------------------------------------------------------------
13
+ # General configuration options
14
+ #---------------------------------------------------------------------------
15
+
16
+ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
17
+ # by quotes) that should identify the project.
18
+
19
+ PROJECT_NAME =
20
+
21
+ # The PROJECT_NUMBER tag can be used to enter a project or revision number.
22
+ # This could be handy for archiving the generated documentation or
23
+ # if some version control system is used.
24
+
25
+ PROJECT_NUMBER =
26
+
27
+ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
28
+ # base path where the generated documentation will be put.
29
+ # If a relative path is entered, it will be relative to the location
30
+ # where doxygen was started. If left blank the current directory will be used.
31
+
32
+ OUTPUT_DIRECTORY =
33
+
34
+ # The OUTPUT_LANGUAGE tag is used to specify the language in which all
35
+ # documentation generated by doxygen is written. Doxygen will use this
36
+ # information to generate all constant output in the proper language.
37
+ # The default language is English, other supported languages are:
38
+ # Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese,
39
+ # Korean, Hungarian, Norwegian, Spanish, Romanian, Russian, Croatian,
40
+ # Polish, Portuguese and Slovene.
41
+
42
+ OUTPUT_LANGUAGE = English
43
+
44
+ # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
45
+ # documentation are documented, even if no documentation was available.
46
+ # Private class members and static file members will be hidden unless
47
+ # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
48
+
49
+ EXTRACT_ALL = YES
50
+
51
+ # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
52
+ # will be included in the documentation.
53
+
54
+ EXTRACT_PRIVATE = NO
55
+
56
+ # If the EXTRACT_STATIC tag is set to YES all static members of a file
57
+ # will be included in the documentation.
58
+
59
+ EXTRACT_STATIC = NO
60
+
61
+ # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
62
+ # undocumented members of documented classes, files or namespaces.
63
+ # If set to NO (the default) these members will be included in the
64
+ # various overviews, but no documentation section is generated.
65
+ # This option has no effect if EXTRACT_ALL is enabled.
66
+
67
+ HIDE_UNDOC_MEMBERS = NO
68
+
69
+ # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
70
+ # undocumented classes that are normally visible in the class hierarchy.
71
+ # If set to NO (the default) these class will be included in the various
72
+ # overviews. This option has no effect if EXTRACT_ALL is enabled.
73
+
74
+ HIDE_UNDOC_CLASSES = NO
75
+
76
+ # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
77
+ # include brief member descriptions after the members that are listed in
78
+ # the file and class documentation (similar to JavaDoc).
79
+ # Set to NO to disable this.
80
+
81
+ BRIEF_MEMBER_DESC = YES
82
+
83
+ # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
84
+ # the brief description of a member or function before the detailed description.
85
+ # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
86
+ # brief descriptions will be completely suppressed.
87
+
88
+ REPEAT_BRIEF = YES
89
+
90
+ # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91
+ # Doxygen will generate a detailed section even if there is only a brief
92
+ # description.
93
+
94
+ ALWAYS_DETAILED_SEC = NO
95
+
96
+ # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
97
+ # path before files name in the file list and in the header files. If set
98
+ # to NO the shortest path that makes the file name unique will be used.
99
+
100
+ FULL_PATH_NAMES = NO
101
+
102
+ # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
103
+ # can be used to strip a user defined part of the path. Stripping is
104
+ # only done if one of the specified strings matches the left-hand part of
105
+ # the path. It is allowed to use relative paths in the argument list.
106
+
107
+ STRIP_FROM_PATH =
108
+
109
+ # The INTERNAL_DOCS tag determines if documentation
110
+ # that is typed after a \internal command is included. If the tag is set
111
+ # to NO (the default) then the documentation will be excluded.
112
+ # Set it to YES to include the internal documentation.
113
+
114
+ INTERNAL_DOCS = NO
115
+
116
+ # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
117
+ # generate a class diagram (in Html and LaTeX) for classes with base or
118
+ # super classes. Setting the tag to NO turns the diagrams off.
119
+
120
+ CLASS_DIAGRAMS = YES
121
+
122
+ # If the SOURCE_BROWSER tag is set to YES then a list of source files will
123
+ # be generated. Documented entities will be cross-referenced with these sources.
124
+
125
+ SOURCE_BROWSER = NO
126
+
127
+ # Setting the INLINE_SOURCES tag to YES will include the body
128
+ # of functions and classes directly in the documentation.
129
+
130
+ INLINE_SOURCES = NO
131
+
132
+ # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
133
+ # doxygen to hide any special comment blocks from generated source code
134
+ # fragments. Normal C and C++ comments will always remain visible.
135
+
136
+ STRIP_CODE_COMMENTS = YES
137
+
138
+ # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
139
+ # file names in lower case letters. If set to YES upper case letters are also
140
+ # allowed. This is useful if you have classes or files whose names only differ
141
+ # in case and if your file system supports case sensitive file names. Windows
142
+ # users are adviced to set this option to NO.
143
+
144
+ CASE_SENSE_NAMES = YES
145
+
146
+ # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
147
+ # will show members with their full class and namespace scopes in the
148
+ # documentation. If set to YES the scope will be hidden.
149
+
150
+ HIDE_SCOPE_NAMES = NO
151
+
152
+ # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
153
+ # will generate a verbatim copy of the header file for each class for
154
+ # which an include is specified. Set to NO to disable this.
155
+
156
+ VERBATIM_HEADERS = YES
157
+
158
+ # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
159
+ # will put list of the files that are included by a file in the documentation
160
+ # of that file.
161
+
162
+ SHOW_INCLUDE_FILES = YES
163
+
164
+ # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
165
+ # will interpret the first line (until the first dot) of a JavaDoc-style
166
+ # comment as the brief description. If set to NO, the JavaDoc
167
+ # comments will behave just like the Qt-style comments (thus requiring an
168
+ # explict @brief command for a brief description.
169
+
170
+ JAVADOC_AUTOBRIEF = NO
171
+
172
+ # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173
+ # member inherits the documentation from any documented member that it
174
+ # reimplements.
175
+
176
+ INHERIT_DOCS = YES
177
+
178
+ # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
179
+ # is inserted in the documentation for inline members.
180
+
181
+ INLINE_INFO = YES
182
+
183
+ # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
184
+ # will sort the (detailed) documentation of file and class members
185
+ # alphabetically by member name. If set to NO the members will appear in
186
+ # declaration order.
187
+
188
+ SORT_MEMBER_DOCS = YES
189
+
190
+ # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
191
+ # tag is set to YES, then doxygen will reuse the documentation of the first
192
+ # member in the group (if any) for the other members of the group. By default
193
+ # all members of a group must be documented explicitly.
194
+
195
+ DISTRIBUTE_GROUP_DOC = NO
196
+
197
+ # The TAB_SIZE tag can be used to set the number of spaces in a tab.
198
+ # Doxygen uses this value to replace tabs by spaces in code fragments.
199
+
200
+ TAB_SIZE = 8
201
+
202
+ # The ENABLE_SECTIONS tag can be used to enable conditional
203
+ # documentation sections, marked by \if sectionname ... \endif.
204
+
205
+ ENABLED_SECTIONS =
206
+
207
+ # The GENERATE_TODOLIST tag can be used to enable (YES) or
208
+ # disable (NO) the todo list. This list is created by putting \todo
209
+ # commands in the documentation.
210
+
211
+ GENERATE_TODOLIST = YES
212
+
213
+ # The GENERATE_TESTLIST tag can be used to enable (YES) or
214
+ # disable (NO) the test list. This list is created by putting \test
215
+ # commands in the documentation.
216
+
217
+ GENERATE_TESTLIST = YES
218
+
219
+ # This tag can be used to specify a number of aliases that acts
220
+ # as commands in the documentation. An alias has the form "name=value".
221
+ # For example adding "sideeffect=\par Side Effects:\n" will allow you to
222
+ # put the command \sideeffect (or @sideeffect) in the documentation, which
223
+ # will result in a user defined paragraph with heading "Side Effects:".
224
+ # You can put \n's in the value part of an alias to insert newlines.
225
+
226
+ ALIASES =
227
+
228
+ #---------------------------------------------------------------------------
229
+ # configuration options related to warning and progress messages
230
+ #---------------------------------------------------------------------------
231
+
232
+ # The QUIET tag can be used to turn on/off the messages that are generated
233
+ # by doxygen. Possible values are YES and NO. If left blank NO is used.
234
+
235
+ QUIET = NO
236
+
237
+ # The WARNINGS tag can be used to turn on/off the warning messages that are
238
+ # generated by doxygen. Possible values are YES and NO. If left blank
239
+ # NO is used.
240
+
241
+ WARNINGS = YES
242
+
243
+ # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
244
+ # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
245
+ # automatically be disabled.
246
+
247
+ WARN_IF_UNDOCUMENTED = YES
248
+
249
+ # The WARN_FORMAT tag determines the format of the warning messages that
250
+ # doxygen can produce. The string should contain the $file, $line, and $text
251
+ # tags, which will be replaced by the file and line number from which the
252
+ # warning originated and the warning text.
253
+
254
+ WARN_FORMAT = "$file:$line: $text"
255
+
256
+ # The WARN_LOGFILE tag can be used to specify a file to which warning
257
+ # and error messages should be written. If left blank the output is written
258
+ # to stderr.
259
+
260
+ WARN_LOGFILE =
261
+
262
+ #---------------------------------------------------------------------------
263
+ # configuration options related to the input files
264
+ #---------------------------------------------------------------------------
265
+
266
+ # The INPUT tag can be used to specify the files and/or directories that contain
267
+ # documented source files. You may enter file names like "myfile.cpp" or
268
+ # directories like "/usr/src/myproject". Separate the files or directories
269
+ # with spaces.
270
+
271
+ INPUT =
272
+
273
+ # If the value of the INPUT tag contains directories, you can use the
274
+ # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
275
+ # and *.h) to filter out the source-files in the directories. If left
276
+ # blank all files are included.
277
+
278
+ FILE_PATTERNS =
279
+
280
+ # The RECURSIVE tag can be used to turn specify whether or not subdirectories
281
+ # should be searched for input files as well. Possible values are YES and NO.
282
+ # If left blank NO is used.
283
+
284
+ RECURSIVE = NO
285
+
286
+ # The EXCLUDE tag can be used to specify files and/or directories that should
287
+ # excluded from the INPUT source files. This way you can easily exclude a
288
+ # subdirectory from a directory tree whose root is specified with the INPUT tag.
289
+
290
+ EXCLUDE =
291
+
292
+ # If the value of the INPUT tag contains directories, you can use the
293
+ # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
294
+ # certain files from those directories.
295
+
296
+ EXCLUDE_PATTERNS =
297
+
298
+ # The EXAMPLE_PATH tag can be used to specify one or more files or
299
+ # directories that contain example code fragments that are included (see
300
+ # the \include command).
301
+
302
+ EXAMPLE_PATH =
303
+
304
+ # If the value of the EXAMPLE_PATH tag contains directories, you can use the
305
+ # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
306
+ # and *.h) to filter out the source-files in the directories. If left
307
+ # blank all files are included.
308
+
309
+ EXAMPLE_PATTERNS =
310
+
311
+ # The IMAGE_PATH tag can be used to specify one or more files or
312
+ # directories that contain image that are included in the documentation (see
313
+ # the \image command).
314
+
315
+ IMAGE_PATH =
316
+
317
+ # The INPUT_FILTER tag can be used to specify a program that doxygen should
318
+ # invoke to filter for each input file. Doxygen will invoke the filter program
319
+ # by executing (via popen()) the command <filter> <input-file>, where <filter>
320
+ # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
321
+ # input file. Doxygen will then use the output that the filter program writes
322
+ # to standard output.
323
+
324
+ INPUT_FILTER =
325
+
326
+ # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
327
+ # INPUT_FILTER) will be used to filter the input files when producing source
328
+ # files to browse.
329
+
330
+ FILTER_SOURCE_FILES = NO
331
+
332
+ #---------------------------------------------------------------------------
333
+ # configuration options related to the alphabetical class index
334
+ #---------------------------------------------------------------------------
335
+
336
+ # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
337
+ # of all compounds will be generated. Enable this if the project
338
+ # contains a lot of classes, structs, unions or interfaces.
339
+
340
+ ALPHABETICAL_INDEX = NO
341
+
342
+ # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
343
+ # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
344
+ # in which this list will be split (can be a number in the range [1..20])
345
+
346
+ COLS_IN_ALPHA_INDEX = 5
347
+
348
+ # In case all classes in a project start with a common prefix, all
349
+ # classes will be put under the same header in the alphabetical index.
350
+ # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
351
+ # should be ignored while generating the index headers.
352
+
353
+ IGNORE_PREFIX =
354
+
355
+ #---------------------------------------------------------------------------
356
+ # configuration options related to the HTML output
357
+ #---------------------------------------------------------------------------
358
+
359
+ # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
360
+ # generate HTML output.
361
+
362
+ GENERATE_HTML = YES
363
+
364
+ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
365
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
366
+ # put in front of it. If left blank `html' will be used as the default path.
367
+
368
+ HTML_OUTPUT = html
369
+
370
+ # The HTML_HEADER tag can be used to specify a personal HTML header for
371
+ # each generated HTML page. If it is left blank doxygen will generate a
372
+ # standard header.
373
+
374
+ HTML_HEADER =
375
+
376
+ # The HTML_FOOTER tag can be used to specify a personal HTML footer for
377
+ # each generated HTML page. If it is left blank doxygen will generate a
378
+ # standard footer.
379
+
380
+ HTML_FOOTER =
381
+
382
+ # The HTML_STYLESHEET tag can be used to specify a user defined cascading
383
+ # style sheet that is used by each HTML page. It can be used to
384
+ # fine-tune the look of the HTML output. If the tag is left blank doxygen
385
+ # will generate a default style sheet
386
+
387
+ HTML_STYLESHEET =
388
+
389
+ # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
390
+ # files or namespaces will be aligned in HTML using tables. If set to
391
+ # NO a bullet list will be used.
392
+
393
+ HTML_ALIGN_MEMBERS = YES
394
+
395
+ # If the GENERATE_HTMLHELP tag is set to YES, additional index files
396
+ # will be generated that can be used as input for tools like the
397
+ # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
398
+ # of the generated HTML documentation.
399
+
400
+ GENERATE_HTMLHELP = NO
401
+
402
+ # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
403
+ # top of each HTML page. The value NO (the default) enables the index and
404
+ # the value YES disables it.
405
+
406
+ DISABLE_INDEX = NO
407
+
408
+ # This tag can be used to set the number of enum values (range [1..20])
409
+ # that doxygen will group on one line in the generated HTML documentation.
410
+
411
+ ENUM_VALUES_PER_LINE = 4
412
+
413
+ # If the GENERATE_TREEVIEW tag is set to YES, a side pannel will be
414
+ # generated containing a tree-like index structure (just like the one that
415
+ # is generated for HTML Help). For this to work a browser that supports
416
+ # JavaScript and frames is required (for instance Netscape 4.0+
417
+ # or Internet explorer 4.0+).
418
+
419
+ GENERATE_TREEVIEW = NO
420
+
421
+ # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
422
+ # used to set the initial width (in pixels) of the frame in which the tree
423
+ # is shown.
424
+
425
+ TREEVIEW_WIDTH = 250
426
+
427
+ #---------------------------------------------------------------------------
428
+ # configuration options related to the LaTeX output
429
+ #---------------------------------------------------------------------------
430
+
431
+ # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
432
+ # generate Latex output.
433
+
434
+ GENERATE_LATEX = YES
435
+
436
+ # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
437
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
438
+ # put in front of it. If left blank `latex' will be used as the default path.
439
+
440
+ LATEX_OUTPUT = latex
441
+
442
+ # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
443
+ # LaTeX documents. This may be useful for small projects and may help to
444
+ # save some trees in general.
445
+
446
+ COMPACT_LATEX = NO
447
+
448
+ # The PAPER_TYPE tag can be used to set the paper type that is used
449
+ # by the printer. Possible values are: a4, a4wide, letter, legal and
450
+ # executive. If left blank a4wide will be used.
451
+
452
+ PAPER_TYPE = a4wide
453
+
454
+ # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
455
+ # packages that should be included in the LaTeX output.
456
+
457
+ EXTRA_PACKAGES =
458
+
459
+ # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
460
+ # the generated latex document. The header should contain everything until
461
+ # the first chapter. If it is left blank doxygen will generate a
462
+ # standard header. Notice: only use this tag if you know what you are doing!
463
+
464
+ LATEX_HEADER =
465
+
466
+ # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
467
+ # is prepared for conversion to pdf (using ps2pdf). The pdf file will
468
+ # contain links (just like the HTML output) instead of page references
469
+ # This makes the output suitable for online browsing using a pdf viewer.
470
+
471
+ PDF_HYPERLINKS = NO
472
+
473
+ # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
474
+ # plain latex in the generated Makefile. Set this option to YES to get a
475
+ # higher quality PDF documentation.
476
+
477
+ USE_PDFLATEX = NO
478
+
479
+ # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
480
+ # command to the generated LaTeX files. This will instruct LaTeX to keep
481
+ # running if errors occur, instead of asking the user for help.
482
+ # This option is also used when generating formulas in HTML.
483
+
484
+ LATEX_BATCHMODE = NO
485
+
486
+ #---------------------------------------------------------------------------
487
+ # configuration options related to the RTF output
488
+ #---------------------------------------------------------------------------
489
+
490
+ # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
491
+ # The RTF output is optimised for Word 97 and may not look very pretty with
492
+ # other RTF readers or editors.
493
+
494
+ GENERATE_RTF = YES
495
+
496
+ # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
497
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
498
+ # put in front of it. If left blank `rtf' will be used as the default path.
499
+
500
+ RTF_OUTPUT = rtf
501
+
502
+ # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
503
+ # RTF documents. This may be useful for small projects and may help to
504
+ # save some trees in general.
505
+
506
+ COMPACT_RTF = NO
507
+
508
+ # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
509
+ # will contain hyperlink fields. The RTF file will
510
+ # contain links (just like the HTML output) instead of page references.
511
+ # This makes the output suitable for online browsing using a WORD or other.
512
+ # programs which support those fields.
513
+ # Note: wordpad (write) and others do not support links.
514
+
515
+ RTF_HYPERLINKS = NO
516
+
517
+ # Load stylesheet definitions from file. Syntax is similar to doxygen's
518
+ # config file, i.e. a series of assigments. You only have to provide
519
+ # replacements, missing definitions are set to their default value.
520
+
521
+ RTF_STYLESHEET_FILE =
522
+
523
+ #---------------------------------------------------------------------------
524
+ # configuration options related to the man page output
525
+ #---------------------------------------------------------------------------
526
+
527
+ # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
528
+ # generate man pages
529
+
530
+ GENERATE_MAN = YES
531
+
532
+ # The MAN_OUTPUT tag is used to specify where the man pages will be put.
533
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
534
+ # put in front of it. If left blank `man' will be used as the default path.
535
+
536
+ MAN_OUTPUT = man
537
+
538
+ # The MAN_EXTENSION tag determines the extension that is added to
539
+ # the generated man pages (default is the subroutine's section .3)
540
+
541
+ MAN_EXTENSION = .3
542
+
543
+ #---------------------------------------------------------------------------
544
+ # configuration options related to the XML output
545
+ #---------------------------------------------------------------------------
546
+
547
+ # If the GENERATE_XML tag is set to YES Doxygen will
548
+ # generate an XML file that captures the structure of
549
+ # the code including all documentation. Warning: This feature
550
+ # is still experimental and very incomplete.
551
+
552
+ GENERATE_XML = NO
553
+
554
+ #---------------------------------------------------------------------------
555
+ # Configuration options related to the preprocessor
556
+ #---------------------------------------------------------------------------
557
+
558
+ # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
559
+ # evaluate all C-preprocessor directives found in the sources and include
560
+ # files.
561
+
562
+ ENABLE_PREPROCESSING = YES
563
+
564
+ # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
565
+ # names in the source code. If set to NO (the default) only conditional
566
+ # compilation will be performed. Macro expansion can be done in a controlled
567
+ # way by setting EXPAND_ONLY_PREDEF to YES.
568
+
569
+ MACRO_EXPANSION = NO
570
+
571
+ # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
572
+ # then the macro expansion is limited to the macros specified with the
573
+ # PREDEFINED and EXPAND_AS_PREDEFINED tags.
574
+
575
+ EXPAND_ONLY_PREDEF = NO
576
+
577
+ # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
578
+ # in the INCLUDE_PATH (see below) will be search if a #include is found.
579
+
580
+ SEARCH_INCLUDES = YES
581
+
582
+ # The INCLUDE_PATH tag can be used to specify one or more directories that
583
+ # contain include files that are not input files but should be processed by
584
+ # the preprocessor.
585
+
586
+ INCLUDE_PATH =
587
+
588
+ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
589
+ # patterns (like *.h and *.hpp) to filter out the header-files in the
590
+ # directories. If left blank, the patterns specified with FILE_PATTERNS will
591
+ # be used.
592
+
593
+ INCLUDE_FILE_PATTERNS =
594
+
595
+ # The PREDEFINED tag can be used to specify one or more macro names that
596
+ # are defined before the preprocessor is started (similar to the -D option of
597
+ # gcc). The argument of the tag is a list of macros of the form: name
598
+ # or name=definition (no spaces). If the definition and the = are
599
+ # omitted =1 is assumed.
600
+
601
+ PREDEFINED =
602
+
603
+ # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
604
+ # this tag can be used to specify a list of macro names that should be expanded.
605
+ # The macro definition that is found in the sources will be used.
606
+ # Use the PREDEFINED tag if you want to use a different macro definition.
607
+
608
+ EXPAND_AS_DEFINED =
609
+
610
+ #---------------------------------------------------------------------------
611
+ # Configuration::addtions related to external references
612
+ #---------------------------------------------------------------------------
613
+
614
+ # The TAGFILES tag can be used to specify one or more tagfiles.
615
+
616
+ TAGFILES =
617
+
618
+ # When a file name is specified after GENERATE_TAGFILE, doxygen will create
619
+ # a tag file that is based on the input files it reads.
620
+
621
+ GENERATE_TAGFILE =
622
+
623
+ # If the ALLEXTERNALS tag is set to YES all external classes will be listed
624
+ # in the class index. If set to NO only the inherited external classes
625
+ # will be listed.
626
+
627
+ ALLEXTERNALS = NO
628
+
629
+ # The PERL_PATH should be the absolute path and name of the perl script
630
+ # interpreter (i.e. the result of `which perl').
631
+
632
+ PERL_PATH = /usr/bin/perl
633
+
634
+ #---------------------------------------------------------------------------
635
+ # Configuration options related to the dot tool
636
+ #---------------------------------------------------------------------------
637
+
638
+ # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
639
+ # available from the path. This tool is part of Graphviz, a graph visualization
640
+ # toolkit from AT&T and Lucent Bell Labs. The other options in this section
641
+ # have no effect if this option is set to NO (the default)
642
+
643
+ HAVE_DOT = NO
644
+
645
+ # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
646
+ # will generate a graph for each documented class showing the direct and
647
+ # indirect inheritance relations. Setting this tag to YES will force the
648
+ # the CLASS_DIAGRAMS tag to NO.
649
+
650
+ CLASS_GRAPH = YES
651
+
652
+ # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
653
+ # will generate a graph for each documented class showing the direct and
654
+ # indirect implementation dependencies (inheritance, containment, and
655
+ # class references variables) of the class with other documented classes.
656
+
657
+ COLLABORATION_GRAPH = YES
658
+
659
+ # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to
660
+ # YES then doxygen will generate a graph for each documented file showing
661
+ # the direct and indirect include dependencies of the file with other
662
+ # documented files.
663
+
664
+ INCLUDE_GRAPH = YES
665
+
666
+ # If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to
667
+ # YES then doxygen will generate a graph for each documented header file showing
668
+ # the documented files that directly or indirectly include this file
669
+
670
+ INCLUDED_BY_GRAPH = YES
671
+
672
+ # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
673
+ # will graphical hierarchy of all classes instead of a textual one.
674
+
675
+ GRAPHICAL_HIERARCHY = YES
676
+
677
+ # The tag DOT_PATH can be used to specify the path where the dot tool can be
678
+ # found. If left blank, it is assumed the dot tool can be found on the path.
679
+
680
+ DOT_PATH =
681
+
682
+ # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
683
+ # (in pixels) of the graphs generated by dot. If a graph becomes larger than
684
+ # this value, doxygen will try to truncate the graph, so that it fits within
685
+ # the specified constraint. Beware that most browsers cannot cope with very
686
+ # large images.
687
+
688
+ MAX_DOT_GRAPH_WIDTH = 1024
689
+
690
+ # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
691
+ # (in pixels) of the graphs generated by dot. If a graph becomes larger than
692
+ # this value, doxygen will try to truncate the graph, so that it fits within
693
+ # the specified constraint. Beware that most browsers cannot cope with very
694
+ # large images.
695
+
696
+ MAX_DOT_GRAPH_HEIGHT = 1024
697
+
698
+ # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
699
+ # generate a legend page explaining the meaning of the various boxes and
700
+ # arrows in the dot generated graphs.
701
+
702
+ GENERATE_LEGEND = YES
703
+
704
+ #---------------------------------------------------------------------------
705
+ # Configuration::addtions related to the search engine
706
+ #---------------------------------------------------------------------------
707
+
708
+ # The SEARCHENGINE tag specifies whether or not a search engine should be
709
+ # used. If set to NO the values of all tags below this one will be ignored.
710
+
711
+ SEARCHENGINE = NO
712
+
713
+ # The CGI_NAME tag should be the name of the CGI script that
714
+ # starts the search engine (doxysearch) with the correct parameters.
715
+ # A script with this name will be generated by doxygen.
716
+
717
+ CGI_NAME = search.cgi
718
+
719
+ # The CGI_URL tag should be the absolute URL to the directory where the
720
+ # cgi binaries are located. See the documentation of your http daemon for
721
+ # details.
722
+
723
+ CGI_URL =
724
+
725
+ # The DOC_URL tag should be the absolute URL to the directory where the
726
+ # documentation is located. If left blank the absolute path to the
727
+ # documentation, with file:// prepended to it, will be used.
728
+
729
+ DOC_URL =
730
+
731
+ # The DOC_ABSPATH tag should be the absolute path to the directory where the
732
+ # documentation is located. If left blank the directory on the local machine
733
+ # will be used.
734
+
735
+ DOC_ABSPATH =
736
+
737
+ # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
738
+ # is installed.
739
+
740
+ BIN_ABSPATH = /usr/local/bin/
741
+
742
+ # The EXT_DOC_PATHS tag can be used to specify one or more paths to
743
+ # documentation generated for other projects. This allows doxysearch to search
744
+ # the documentation for these projects as well.
745
+
746
+ EXT_DOC_PATHS =