├── .gitattributes ├── .gitignore ├── README.md ├── include └── array.h ├── scripts ├── array.doxygen ├── osx │ └── test └── windows │ └── test.bat └── src └── tests.c /.gitattributes: -------------------------------------------------------------------------------- 1 | # Autodetect text files 2 | * text=auto 3 | 4 | # Force the following filetypes to have unix line endings 5 | *.* text eol=lf 6 | 7 | # Force images/fonts to be handled as binaries 8 | *.jpg binary 9 | *.jpeg binary 10 | *.gif binary 11 | *.png binary 12 | *.t3x binary 13 | *.t3d binary 14 | *.exe binary 15 | *.data binary 16 | *.ttf binary 17 | *.eof binary 18 | *.eot binary 19 | *.swf binary 20 | *.mov binary 21 | *.mp4 binary 22 | *.mp3 binary 23 | *.ogg binary 24 | *.flv binary -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | bin/ 2 | obj/ 3 | docs/ 4 | 5 | # OS X 6 | .DS_Store 7 | 8 | # Xcode user data and build folders 9 | xcuserdata 10 | /source/DerivedData 11 | /source/game/bundle 12 | 13 | # vim tmp file(s) 14 | *.swp 15 | 16 | # sublime project files 17 | *.sublime-* 18 | 19 | # Windows project and build files 20 | *.vcxproj.user 21 | *.obj 22 | *.sdf 23 | *.opensdf 24 | *.opendb 25 | *.pdb 26 | *.ipch 27 | *.suo 28 | *.tlog 29 | *.log 30 | 31 | # Windows folders 32 | Debug/ 33 | Release/ 34 | packages/ 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # c-array 2 | A simple std::vector-style array for C 3 | 4 | ```C 5 | array_t(int) a = array_null; 6 | 7 | // allocate array 'a' with capacity of int[16], and no destructor callback 8 | array_alloc(a, 16, NULL); 9 | 10 | array_append(a) = 1; // append to the array, and assign 1 to the appended integer 11 | 12 | array(a)[0] = 2; // change the value at index 0 from 1 to 2 13 | 14 | array_remove(a, 0); // remove integer at index 0 15 | 16 | for (int i = 0; i < 10; ++i) { 17 | array_append(a) = i; 18 | } 19 | 20 | // index-based iteration 21 | const size_t a_size = array_size(a); 22 | for (int i = 0; i < a_size; ++i) { 23 | printf("%i, ", a[i]); 24 | } 25 | puts("\n"); 26 | 27 | 28 | // pointer-based iteration 29 | const int* const end = array_end(a); 30 | for (int* itr = array_begin(a); itr < end; ++itr) { 31 | printf("%i, ", *itr); 32 | } 33 | puts("\n"); 34 | 35 | array_free(a); // free memory 36 | ``` -------------------------------------------------------------------------------- /include/array.h: -------------------------------------------------------------------------------- 1 | /** 2 | @file array.h 3 | @author Garett Bass (https://github.com/garettbass) 4 | @copyright Copyright (c) 2016 Garett Bass (https://github.com/garettbass) 5 | 6 | The MIT License (MIT) 7 | Copyright (c) 2016 Garett Bass (https://github.com/garettbass) 8 | 9 | Permission is hereby granted, free of charge, to any person obtaining a copy of 10 | this software and associated documentation files (the "Software"), to deal in 11 | the Software without restriction, including without limitation the rights to 12 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 13 | of the Software, and to permit persons to whom the Software is furnished to do 14 | so, subject to the following conditions: 15 | 16 | The above copyright notice and this permission notice shall be included in all 17 | copies or substantial portions of the Software. 18 | 19 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 22 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 23 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 24 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 25 | SOFTWARE. 26 | */ 27 | #pragma once 28 | #include 29 | 30 | 31 | #if __cplusplus 32 | extern "C" { 33 | #endif // __cplusplus 34 | 35 | 36 | #ifndef array_allocator 37 | static inline void* array_allocator(void* ptr, size_t size) { 38 | #ifndef realloc 39 | extern void* realloc(void* ptr, size_t size); 40 | #endif 41 | #ifndef free 42 | extern void free(void* ptr); 43 | #endif 44 | return size ? (realloc(ptr, size)) : (free(ptr),(void*)NULL); 45 | } 46 | #endif 47 | 48 | 49 | //------------------------------------------------------------------------------ 50 | 51 | 52 | #define array_t(T) T* 53 | 54 | 55 | // void array_alloc(T*& a, size_t capacity, void (*destructor)(T* begin, T* end)) 56 | #define array_alloc(a, capacity, destructor) \ 57 | (_array_alloc(_array_ptr((a)), (capacity) * _array_stride((a)), (array_allocator), (_array_destructor_t)(destructor))) 58 | /**< Allocates initial storage for a dynamic array. 59 | 60 | @param a - the array for which storage will be allocated 61 | @param capacity - the initial capacity of the dynamic array 62 | @param destructor - an optional destructor to be called by array_remove, array_clear, and array_free 63 | 64 | @code{.c} 65 | array_t(int) ia = NULL; 66 | array_alloc(ia, 16, NULL); // NULL destructor for POD types 67 | 68 | // ... 69 | 70 | typedef array_t(FILE*) file_array; 71 | void file_array_destructor(FILE** itr, FILE** end) { 72 | for (; itr < end; ++itr) fclose(*itr); 73 | } 74 | 75 | // ... 76 | 77 | file_array files = NULL; 78 | array_alloc(files, 16, file_array_destructor); // destructor closes FILE* 79 | array_append(files, fopen("some/file", "r")); 80 | @endcode 81 | @hideinitializer **/ 82 | 83 | // void array_free(T*& a) 84 | #define array_free(a) \ 85 | (_array_free(_array_ptr((a)))) 86 | /**< Frees storage held by a dynamic array. 87 | @hideinitializer **/ 88 | 89 | 90 | // void array_reserve(T*& a, size_t capacity) 91 | #define array_reserve(a, capacity) \ 92 | (_array_reserve(_array_ptr((a)), (capacity) * _array_stride((a)))) 93 | /**< Reserves additional storage for a dynamic array. 94 | 95 | After a call to array_reserve(), the dynamic array's capacity will be at least 96 | as large as the requested capacity, possibly larger. 97 | @hideinitializer **/ 98 | 99 | 100 | // void array_resize(T*& a, size_t size) 101 | #define array_resize(a, size) \ 102 | (_array_resize(_array_ptr((a)), (size) * _array_stride((a)))) 103 | /**< Resizes the dynamic array. 104 | 105 | If the new size is smaller than the old size, old elements are destructed. 106 | If the new size is greater than before, new elements are zero-initialized. 107 | @hideinitializer **/ 108 | 109 | 110 | // void array_shrink(T*& a) 111 | #define array_shrink(a) \ 112 | (_array_shrink(_array_ptr((a)))) 113 | /**< Shrinks the dynamic array's storage to fit the array's current size. 114 | @hideinitializer **/ 115 | 116 | 117 | // size_t array_capacity(T* a) 118 | #define array_capacity(a) \ 119 | (_array_capacity(_array_ptr((a))) / _array_stride((a))) 120 | /**< Returns the number of elements that can fit in the dynamic array's storage 121 | without allocating additional memory, or zero for NULL arrays. 122 | @hideinitializer **/ 123 | 124 | 125 | // int array_compare(T* a, T* a) 126 | #define array_compare(a, b) \ 127 | (_array_compare(_array_ptr((a)), _array_ptr((b)))) 128 | /**< Performs a lexicographic comparison of two arrays using memcmp(). 129 | @hideinitializer **/ 130 | 131 | 132 | // size_t array_size(T* a) 133 | #define array_size(a) \ 134 | (_array_size(_array_ptr((a))) / _array_stride((a))) 135 | /**< Returns the number of elements stored in the dynamic array, or zero for 136 | NULL arrays. 137 | @hideinitializer **/ 138 | 139 | 140 | // bool array_empty(T* a) 141 | #define array_empty(a) \ 142 | ((bool)(_array_size(_array_ptr((a))) == 0)) 143 | /**< Returns true if the dynamic array's size is zero. 144 | @hideinitializer **/ 145 | 146 | 147 | // T& array_front(T* array) 148 | #define array_front(a) \ 149 | ((a)[ _array_front_index(_array_ptr((a))) ]) 150 | /**< Returns a reference to the first element in the dynamic array. 151 | An assertion will fail if the array is empty. 152 | @hideinitializer **/ 153 | 154 | 155 | // T& array_back(T* array) 156 | #define array_back(a) \ 157 | ((a)[ _array_back_index(_array_ptr((a)), _array_stride((a))) ]) 158 | /**< Returns a reference to the final element in the dynamic array. 159 | An assertion will fail if the array is empty. 160 | @hideinitializer **/ 161 | 162 | 163 | // void array_append(T*& array, T value) 164 | #define array_append(a, v) \ 165 | ( _array_append(_array_ptr((a)), _array_stride((a))), array_back(a) = v ) 166 | /**< Appends a single element to the dynamic array, allocating additional 167 | storage if necessary. 168 | 169 | @code{.c} 170 | array_t(int) ia = NULL; 171 | array_alloc(ia, 16, NULL); 172 | // ... 173 | array_append(ia, 123); 174 | assert(ia[0] == 123); 175 | @endcode 176 | @hideinitializer **/ 177 | 178 | 179 | // void array_insert(T*& a, size_t index, T value) 180 | #define array_insert(a, index, v) \ 181 | ( _array_insert(_array_ptr((a)), _array_offset((a), (index)), _array_stride((a))), (a)[index] = v ) 182 | /**< Inserts a single element at the provided index, allocating additional 183 | storage if necessary. 184 | 185 | @code{.c} 186 | array_t(int) ia = NULL; 187 | array_alloc(ia, 16, NULL); 188 | // ... 189 | array_insert(ia, 1, 123); 190 | assert(ia[1] == 123); 191 | @endcode 192 | @hideinitializer **/ 193 | 194 | 195 | // void array_remove(T*& a, size_t index) 196 | #define array_remove(a, index) \ 197 | (_array_remove(_array_ptr((a)), _array_offset((a), (index)), _array_stride((a)))) 198 | /**< Removes a single element from the dynamic array at index. The removed 199 | element is passed to the array's destructor if it is not NULL. 200 | @hideinitializer **/ 201 | 202 | 203 | // void array_remove_unordered(T*& a, size_t index) 204 | #define array_remove_unordered(a, index) \ 205 | (_array_remove_unordered(_array_ptr((a)), _array_offset((a), (index)), _array_stride((a)))) 206 | /**< Removes a single element from the dynamic array at index. The removed 207 | element is passed to the array's destructor if it is not NULL. The removed 208 | element is replaced by the final element. This can be faster than shifting 209 | the remaining elements into place to maintain their relative order. 210 | @hideinitializer **/ 211 | 212 | 213 | // void array_remove_n(T*& a, size_t index, size_t count) 214 | #define array_remove_n(a, index, count) \ 215 | (_array_remove(_array_ptr((a)), _array_offset((a), (index)), _array_offset((a), (count)))) 216 | /**< Removes count elements from the dynamic array, starting at index. Removed 217 | elements are passed to the array's destructor if it is not NULL. 218 | @hideinitializer **/ 219 | 220 | 221 | // void array_clear(T*& a) 222 | #define array_clear(a) \ 223 | (_array_clear(_array_ptr((a)))) 224 | /**< Removes all elements from the dynamic array. Removed elements are passed 225 | to the array's destructor if it is not NULL. 226 | @hideinitializer **/ 227 | 228 | 229 | // T* array_begin(T* array) 230 | #define array_begin(a) (a) 231 | /**< Returns a pointer to the first element of the array, or NULL if the array 232 | is NULL. 233 | @hideinitializer **/ 234 | 235 | 236 | // T* array_end(T* array) 237 | #define array_end(a) ((a) + (_array_size(_array_ptr((a))) / _array_stride((a)))) 238 | /**< Returns a pointer just past the last element of the array, or NULL if the 239 | array is NULL. 240 | @hideinitializer **/ 241 | 242 | 243 | //============================================================================== 244 | 245 | 246 | #define _array_ptr(a) ((_array_t*)&(a)) 247 | 248 | #define _array_stride(a) (sizeof((a)[0])) 249 | 250 | #define _array_offset(a, n) ((size_t)(_array_stride((a)) * n)) 251 | 252 | 253 | //------------------------------------------------------------------------------ 254 | 255 | 256 | #ifndef _array_assert 257 | static inline 258 | void _array_error(const char* file, const int line, const char* msg) { 259 | #ifndef printf 260 | extern int printf(const char*, ...); 261 | #endif 262 | #ifndef exit 263 | extern void exit(int); 264 | #endif 265 | printf("%s:%i: %s\n", file, line, msg); 266 | exit(1); 267 | } 268 | #define _array_assert(expr, msg) \ 269 | (((expr) ? 1 : (_array_error(__FILE__, __LINE__, "assert("#expr") failed: "msg), 0))) 270 | #endif 271 | 272 | 273 | #ifndef _array_memcmp 274 | #define _array_memcmp memcmp 275 | #ifndef memcmp 276 | int memcmp(const void*, const void*, size_t); 277 | #endif 278 | #endif 279 | 280 | 281 | #ifndef _array_memcpy 282 | #define _array_memcpy memcpy 283 | #ifndef memcpy 284 | void* memcpy(void*, const void*, size_t); 285 | #endif 286 | #endif 287 | 288 | 289 | #ifndef _array_memmove 290 | #define _array_memmove memmove 291 | #ifndef memmove 292 | void* memmove(void*, const void*, size_t); 293 | #endif 294 | #endif 295 | 296 | 297 | #ifndef _array_memset 298 | #define _array_memset memset 299 | #ifndef memset 300 | void* memset(void*, int, size_t); 301 | #endif 302 | #endif 303 | 304 | 305 | //------------------------------------------------------------------------------ 306 | 307 | 308 | typedef char* _array_t; 309 | 310 | typedef void* (*_array_allocator_t)(void* array, size_t size); 311 | 312 | typedef void (*_array_destructor_t)(void* begin, void* end); 313 | 314 | typedef struct { 315 | _array_allocator_t allocator; 316 | _array_destructor_t destructor; 317 | size_t capacity, size; 318 | char data[0]; 319 | } _array_header_t; 320 | 321 | 322 | //------------------------------------------------------------------------------ 323 | 324 | 325 | static inline 326 | size_t _array_ceilpow2(size_t x) { 327 | enum { _32_OR_0 = 32 * (sizeof(void*) > 4) }; 328 | x -= 1; 329 | x |= (x >> 1); 330 | x |= (x >> 2); 331 | x |= (x >> 4); 332 | x |= (x >> 8); 333 | x |= (x >> 16); 334 | x |= (x >> _32_OR_0); 335 | x += 1; 336 | return x ? x : ~((size_t)0); 337 | } 338 | 339 | 340 | static inline 341 | _array_header_t* _array_header(_array_t* const a) { 342 | _array_header_t* const headers = (_array_header_t*)(*a); 343 | return headers ? (headers - 1) : headers; 344 | } 345 | 346 | 347 | static inline 348 | void _array_alloc(_array_t* a, const size_t capacity, _array_allocator_t allocator, _array_destructor_t destructor) { 349 | _array_assert(!(*a), "array already allocated"); 350 | const size_t mem_size = sizeof(_array_header_t) + capacity; 351 | _array_header_t* const header = 352 | (_array_header_t*)allocator(NULL, mem_size); 353 | header->allocator = allocator; 354 | header->destructor = destructor; 355 | header->capacity = capacity; 356 | header->size = 0; 357 | (*a) = header->data; 358 | } 359 | 360 | 361 | static inline 362 | void _array_free(_array_t* a) { 363 | _array_header_t* header = _array_header(a); 364 | if (header) { 365 | if (header->destructor) { 366 | const size_t free_size = header->size; 367 | char* free_begin = (*a); 368 | char* free_end = free_begin + free_size; 369 | header->destructor(free_begin, free_end); 370 | } 371 | header = header->allocator(header, 0); 372 | _array_assert(header == NULL, "allocator leaked memory"); 373 | } 374 | (*a) = NULL; 375 | } 376 | 377 | 378 | static inline 379 | size_t _array_capacity(_array_t* const a) { 380 | const _array_header_t* const header = _array_header(a); 381 | return header ? header->capacity : ((size_t)0); 382 | } 383 | 384 | 385 | static inline 386 | size_t _array_size(_array_t* const a) { 387 | const _array_header_t* const header = _array_header(a); 388 | return header ? header->size : ((size_t)0); 389 | } 390 | 391 | 392 | static inline 393 | void _array_grow(_array_t* a, const size_t capacity) { 394 | const size_t mem_size = sizeof(_array_header_t) + capacity; 395 | _array_header_t* header = _array_header(a); 396 | header = (_array_header_t*)header->allocator(header, mem_size); 397 | header->capacity = capacity; 398 | (*a) = header->data; 399 | } 400 | 401 | 402 | static inline 403 | void _array_shrink(_array_t* a) { 404 | _array_header_t* old_header = _array_header(a); 405 | if (old_header->capacity > old_header->size) { 406 | const size_t new_capacity = old_header->size; 407 | const size_t mem_size = sizeof(_array_header_t) + new_capacity; 408 | const _array_allocator_t allocator = old_header->allocator; 409 | _array_header_t* new_header = (_array_header_t*)allocator(NULL, mem_size); 410 | _array_memcpy(new_header, old_header, mem_size); 411 | old_header = old_header->allocator(old_header, 0); 412 | _array_assert(old_header == NULL, "allocator leaked memory"); 413 | new_header->capacity = new_capacity; 414 | (*a) = new_header->data; 415 | } 416 | } 417 | 418 | 419 | static inline 420 | void _array_reserve(_array_t* a, const size_t capacity) { 421 | _array_assert((*a), "array uninitialized"); 422 | if (_array_capacity(a) < capacity) { 423 | _array_grow(a, _array_ceilpow2(capacity)); 424 | _array_assert(_array_capacity(a) >= capacity, "_array_grow() failed"); 425 | } 426 | } 427 | 428 | 429 | static inline 430 | void _array_resize(_array_t* a, const size_t new_size) { 431 | _array_assert((*a), "array uninitialized"); 432 | _array_header_t* header = _array_header(a); 433 | const size_t old_size = header->size; 434 | if (old_size > new_size) { 435 | if (header->destructor) { 436 | const size_t discard_size = old_size - new_size; 437 | char* discard_begin = (*a) + new_size; 438 | char* discard_end = discard_begin + discard_size; 439 | header->destructor(discard_begin, discard_end); 440 | } 441 | header->size = new_size; 442 | return; 443 | } 444 | if (new_size > old_size) { 445 | _array_reserve(a, new_size); 446 | _array_header(a)->size = new_size; 447 | const size_t append_size = new_size - old_size; 448 | char* append_begin = (*a) + old_size; 449 | _array_memset(append_begin, 0, append_size); 450 | return; 451 | } 452 | } 453 | 454 | 455 | static inline 456 | int _array_compare(_array_t* a, _array_t* b) { 457 | const size_t size_a = _array_size(a); 458 | const size_t size_b = _array_size(b); 459 | const size_t size = (size_a < size_b) ? size_a : size_b; 460 | const int cmp = _array_memcmp((*a), (*b), size); 461 | return (cmp) ? cmp : (int)(size_b - size_a); 462 | } 463 | 464 | 465 | static inline 466 | size_t _array_append(_array_t* a, const size_t append_size) { 467 | _array_assert((*a), "array uninitialized"); 468 | const size_t append_offset = _array_size(a); 469 | const size_t new_size = append_offset + append_size; 470 | _array_reserve(a, new_size); 471 | _array_header(a)->size = new_size; 472 | return append_offset; 473 | } 474 | 475 | 476 | static inline 477 | size_t _array_insert(_array_t* a, const size_t insert_offset, const size_t insert_size) { 478 | _array_assert((*a), "array uninitialized"); 479 | const size_t old_size = _array_size(a); 480 | _array_assert(insert_offset <= old_size, "array index out of range"); 481 | const size_t new_size = old_size + insert_size; 482 | _array_reserve(a, new_size); 483 | _array_header(a)->size = new_size; 484 | char* insert_begin = (*a) + insert_offset; 485 | char* insert_end = insert_begin + insert_size; 486 | const size_t end_size = old_size - insert_offset; 487 | _array_memmove(insert_end, insert_begin, end_size); 488 | return insert_offset; 489 | } 490 | 491 | 492 | static inline 493 | void _array_remove(_array_t* a, const size_t remove_offset, const size_t remove_size) { 494 | _array_assert((*a), "array uninitialized"); 495 | const size_t old_size = _array_size(a); 496 | _array_assert(remove_offset <= old_size, "array index out of range"); 497 | _array_assert(remove_size <= old_size - remove_offset, "array index out of range"); 498 | const size_t new_size = old_size - remove_size; 499 | _array_header_t* header = _array_header(a); 500 | char* remove_begin = (*a) + remove_offset; 501 | char* remove_end = remove_begin + remove_size; 502 | if (header->destructor) { 503 | header->destructor(remove_begin, remove_end); 504 | } 505 | const size_t tail_size = new_size - remove_offset; 506 | _array_memmove(remove_begin, remove_end, tail_size); 507 | header->size = new_size; 508 | } 509 | 510 | 511 | static inline 512 | void _array_remove_unordered(_array_t* a, const size_t remove_offset, const size_t remove_size) { 513 | _array_assert((*a), "array uninitialized"); 514 | const size_t old_size = _array_size(a); 515 | _array_assert(remove_offset <= old_size, "array index out of range"); 516 | _array_assert(remove_size <= old_size - remove_offset, "array index out of range"); 517 | const size_t new_size = old_size - remove_size; 518 | _array_header_t* header = _array_header(a); 519 | char* remove_begin = (*a) + remove_offset; 520 | char* remove_end = remove_begin + remove_size; 521 | if (header->destructor) { 522 | header->destructor(remove_begin, remove_end); 523 | } 524 | char* tail_begin = (*a) + new_size; 525 | _array_memmove(remove_begin, tail_begin, remove_size); 526 | header->size = new_size; 527 | } 528 | 529 | 530 | static inline 531 | size_t _array_front_index(_array_t* const a) { 532 | _array_assert((*a), "array uninitialized"); 533 | return 0; 534 | } 535 | 536 | 537 | static inline 538 | size_t _array_back_index(_array_t* const a, const size_t stride) { 539 | _array_assert((*a), "array uninitialized"); 540 | const size_t size = _array_size(a); 541 | _array_assert(size, "array index out of range"); 542 | return (size / stride) - 1; 543 | } 544 | 545 | 546 | static inline 547 | void _array_clear(_array_t* const a) { 548 | _array_assert((*a), "array uninitialized"); 549 | _array_header_t* header = _array_header(a); 550 | const size_t clear_size = header->size; 551 | char* clear_begin = (*a); 552 | char* clear_end = clear_begin + clear_size; 553 | if (header->destructor) { 554 | header->destructor(clear_begin, clear_end); 555 | } 556 | header->size = 0; 557 | } 558 | 559 | 560 | //------------------------------------------------------------------------------ 561 | 562 | 563 | #if __cplusplus 564 | } // extern "C" 565 | #endif // __cplusplus -------------------------------------------------------------------------------- /scripts/array.doxygen: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.2 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 | # Project related configuration options 15 | #--------------------------------------------------------------------------- 16 | 17 | # This tag specifies the encoding used for all characters in the config file 18 | # that follow. The default is UTF-8 which is also the encoding used for all 19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 20 | # iconv built into libc) for the transcoding. See 21 | # http://www.gnu.org/software/libiconv for the list of possible encodings. 22 | 23 | DOXYFILE_ENCODING = UTF-8 24 | 25 | # The PROJECT_NAME tag is a single word (or sequence of words) that should 26 | # identify the project. Note that if you do not use Doxywizard you need 27 | # to put quotes around the project name if it contains spaces. 28 | 29 | PROJECT_NAME = "c-array" 30 | 31 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. 32 | # This could be handy for archiving the generated documentation or 33 | # if some version control system is used. 34 | 35 | PROJECT_NUMBER = 36 | 37 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 38 | # for a project that appears at the top of each page and should give viewer 39 | # a quick idea about the purpose of the project. Keep the description short. 40 | 41 | PROJECT_BRIEF = "A simple std::vector-style array for C." 42 | 43 | # With the PROJECT_LOGO tag one can specify an logo or icon that is 44 | # included in the documentation. The maximum height of the logo should not 45 | # exceed 55 pixels and the maximum width should not exceed 200 pixels. 46 | # Doxygen will copy the logo to the output directory. 47 | 48 | PROJECT_LOGO = 49 | 50 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 51 | # base path where the generated documentation will be put. 52 | # If a relative path is entered, it will be relative to the location 53 | # where doxygen was started. If left blank the current directory will be used. 54 | 55 | OUTPUT_DIRECTORY = docs 56 | 57 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 58 | # 4096 sub-directories (in 2 levels) under the output directory of each output 59 | # format and will distribute the generated files over these directories. 60 | # Enabling this option can be useful when feeding doxygen a huge amount of 61 | # source files, where putting all generated files in the same directory would 62 | # otherwise cause performance problems for the file system. 63 | 64 | CREATE_SUBDIRS = NO 65 | 66 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 67 | # documentation generated by doxygen is written. Doxygen will use this 68 | # information to generate all constant output in the proper language. 69 | # The default language is English, other supported languages are: 70 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 71 | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 72 | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 73 | # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 74 | # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 75 | # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 76 | 77 | OUTPUT_LANGUAGE = English 78 | 79 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 80 | # include brief member descriptions after the members that are listed in 81 | # the file and class documentation (similar to JavaDoc). 82 | # Set to NO to disable this. 83 | 84 | BRIEF_MEMBER_DESC = YES 85 | 86 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 87 | # the brief description of a member or function before the detailed description. 88 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 89 | # brief descriptions will be completely suppressed. 90 | 91 | REPEAT_BRIEF = YES 92 | 93 | # This tag implements a quasi-intelligent brief description abbreviator 94 | # that is used to form the text in various listings. Each string 95 | # in this list, if found as the leading text of the brief description, will be 96 | # stripped from the text and the result after processing the whole list, is 97 | # used as the annotated text. Otherwise, the brief description is used as-is. 98 | # If left blank, the following values are used ("$name" is automatically 99 | # replaced with the name of the entity): "The $name class" "The $name widget" 100 | # "The $name file" "is" "provides" "specifies" "contains" 101 | # "represents" "a" "an" "the" 102 | 103 | ABBREVIATE_BRIEF = 104 | 105 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 106 | # Doxygen will generate a detailed section even if there is only a brief 107 | # description. 108 | 109 | ALWAYS_DETAILED_SEC = NO 110 | 111 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 112 | # inherited members of a class in the documentation of that class as if those 113 | # members were ordinary class members. Constructors, destructors and assignment 114 | # operators of the base classes will not be shown. 115 | 116 | INLINE_INHERITED_MEMB = NO 117 | 118 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 119 | # path before files name in the file list and in the header files. If set 120 | # to NO the shortest path that makes the file name unique will be used. 121 | 122 | FULL_PATH_NAMES = YES 123 | 124 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 125 | # can be used to strip a user-defined part of the path. Stripping is 126 | # only done if one of the specified strings matches the left-hand part of 127 | # the path. The tag can be used to show relative paths in the file list. 128 | # If left blank the directory from which doxygen is run is used as the 129 | # path to strip. Note that you specify absolute paths here, but also 130 | # relative paths, which will be relative from the directory where doxygen is 131 | # started. 132 | 133 | STRIP_FROM_PATH = 134 | 135 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 136 | # the path mentioned in the documentation of a class, which tells 137 | # the reader which header file to include in order to use a class. 138 | # If left blank only the name of the header file containing the class 139 | # definition is used. Otherwise one should specify the include paths that 140 | # are normally passed to the compiler using the -I flag. 141 | 142 | STRIP_FROM_INC_PATH = 143 | 144 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 145 | # (but less readable) file names. This can be useful if your file system 146 | # doesn't support long names like on DOS, Mac, or CD-ROM. 147 | 148 | SHORT_NAMES = NO 149 | 150 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 151 | # will interpret the first line (until the first dot) of a JavaDoc-style 152 | # comment as the brief description. If set to NO, the JavaDoc 153 | # comments will behave just like regular Qt-style comments 154 | # (thus requiring an explicit @brief command for a brief description.) 155 | 156 | JAVADOC_AUTOBRIEF = NO 157 | 158 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 159 | # interpret the first line (until the first dot) of a Qt-style 160 | # comment as the brief description. If set to NO, the comments 161 | # will behave just like regular Qt-style comments (thus requiring 162 | # an explicit \brief command for a brief description.) 163 | 164 | QT_AUTOBRIEF = NO 165 | 166 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 167 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// 168 | # comments) as a brief description. This used to be the default behaviour. 169 | # The new default is to treat a multi-line C++ comment block as a detailed 170 | # description. Set this tag to YES if you prefer the old behaviour instead. 171 | 172 | MULTILINE_CPP_IS_BRIEF = YES 173 | 174 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 175 | # member inherits the documentation from any documented member that it 176 | # re-implements. 177 | 178 | INHERIT_DOCS = YES 179 | 180 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 181 | # a new page for each member. If set to NO, the documentation of a member will 182 | # be part of the file/class/namespace that contains it. 183 | 184 | SEPARATE_MEMBER_PAGES = NO 185 | 186 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. 187 | # Doxygen uses this value to replace tabs by spaces in code fragments. 188 | 189 | TAB_SIZE = 4 190 | 191 | # This tag can be used to specify a number of aliases that acts 192 | # as commands in the documentation. An alias has the form "name=value". 193 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to 194 | # put the command \sideeffect (or @sideeffect) in the documentation, which 195 | # will result in a user-defined paragraph with heading "Side Effects:". 196 | # You can put \n's in the value part of an alias to insert newlines. 197 | 198 | ALIASES = 199 | 200 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 201 | # A mapping has the form "name=value". For example adding 202 | # "class=itcl::class" will allow you to use the command class in the 203 | # itcl::class meaning. 204 | 205 | TCL_SUBST = 206 | 207 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 208 | # sources only. Doxygen will then generate output that is more tailored for C. 209 | # For instance, some of the names that are used will be different. The list 210 | # of all members will be omitted, etc. 211 | 212 | OPTIMIZE_OUTPUT_FOR_C = NO 213 | 214 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 215 | # sources only. Doxygen will then generate output that is more tailored for 216 | # Java. For instance, namespaces will be presented as packages, qualified 217 | # scopes will look different, etc. 218 | 219 | OPTIMIZE_OUTPUT_JAVA = NO 220 | 221 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 222 | # sources only. Doxygen will then generate output that is more tailored for 223 | # Fortran. 224 | 225 | OPTIMIZE_FOR_FORTRAN = NO 226 | 227 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 228 | # sources. Doxygen will then generate output that is tailored for 229 | # VHDL. 230 | 231 | OPTIMIZE_OUTPUT_VHDL = NO 232 | 233 | # Doxygen selects the parser to use depending on the extension of the files it 234 | # parses. With this tag you can assign which parser to use for a given 235 | # extension. Doxygen has a built-in mapping, but you can override or extend it 236 | # using this tag. The format is ext=language, where ext is a file extension, 237 | # and language is one of the parsers supported by doxygen: IDL, Java, 238 | # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 239 | # C++. For instance to make doxygen treat .inc files as Fortran files (default 240 | # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 241 | # that for custom extensions you also need to set FILE_PATTERNS otherwise the 242 | # files are not read by doxygen. 243 | 244 | EXTENSION_MAPPING = 245 | 246 | # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 247 | # comments according to the Markdown format, which allows for more readable 248 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 249 | # The output of markdown processing is further processed by doxygen, so you 250 | # can mix doxygen, HTML, and XML commands with Markdown formatting. 251 | # Disable only in case of backward compatibilities issues. 252 | 253 | MARKDOWN_SUPPORT = YES 254 | 255 | # When enabled doxygen tries to link words that correspond to documented classes, 256 | # or namespaces to their corresponding documentation. Such a link can be 257 | # prevented in individual cases by by putting a % sign in front of the word or 258 | # globally by setting AUTOLINK_SUPPORT to NO. 259 | 260 | AUTOLINK_SUPPORT = YES 261 | 262 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 263 | # to include (a tag file for) the STL sources as input, then you should 264 | # set this tag to YES in order to let doxygen match functions declarations and 265 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 266 | # func(std::string) {}). This also makes the inheritance and collaboration 267 | # diagrams that involve STL classes more complete and accurate. 268 | 269 | BUILTIN_STL_SUPPORT = NO 270 | 271 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 272 | # enable parsing support. 273 | 274 | CPP_CLI_SUPPORT = NO 275 | 276 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 277 | # Doxygen will parse them like normal C++ but will assume all classes use public 278 | # instead of private inheritance when no explicit protection keyword is present. 279 | 280 | SIP_SUPPORT = NO 281 | 282 | # For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO. 283 | 284 | IDL_PROPERTY_SUPPORT = NO 285 | 286 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 287 | # tag is set to YES, then doxygen will reuse the documentation of the first 288 | # member in the group (if any) for the other members of the group. By default 289 | # all members of a group must be documented explicitly. 290 | 291 | DISTRIBUTE_GROUP_DOC = NO 292 | 293 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 294 | # the same type (for instance a group of public functions) to be put as a 295 | # subgroup of that type (e.g. under the Public Functions section). Set it to 296 | # NO to prevent subgrouping. Alternatively, this can be done per class using 297 | # the \nosubgrouping command. 298 | 299 | SUBGROUPING = YES 300 | 301 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 302 | # unions are shown inside the group in which they are included (e.g. using 303 | # @ingroup) instead of on a separate page (for HTML and Man pages) or 304 | # section (for LaTeX and RTF). 305 | 306 | INLINE_GROUPED_CLASSES = NO 307 | 308 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 309 | # unions with only public data fields will be shown inline in the documentation 310 | # of the scope in which they are defined (i.e. file, namespace, or group 311 | # documentation), provided this scope is documented. If set to NO (the default), 312 | # structs, classes, and unions are shown on a separate page (for HTML and Man 313 | # pages) or section (for LaTeX and RTF). 314 | 315 | INLINE_SIMPLE_STRUCTS = YES 316 | 317 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 318 | # is documented as struct, union, or enum with the name of the typedef. So 319 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 320 | # with name TypeT. When disabled the typedef will appear as a member of a file, 321 | # namespace, or class. And the struct will be named TypeS. This can typically 322 | # be useful for C code in case the coding convention dictates that all compound 323 | # types are typedef'ed and only the typedef is referenced, never the tag name. 324 | 325 | TYPEDEF_HIDES_STRUCT = YES 326 | 327 | # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 328 | # determine which symbols to keep in memory and which to flush to disk. 329 | # When the cache is full, less often used symbols will be written to disk. 330 | # For small to medium size projects (<1000 input files) the default value is 331 | # probably good enough. For larger projects a too small cache size can cause 332 | # doxygen to be busy swapping symbols to and from disk most of the time 333 | # causing a significant performance penalty. 334 | # If the system has enough physical memory increasing the cache will improve the 335 | # performance by keeping more symbols in memory. Note that the value works on 336 | # a logarithmic scale so increasing the size by one will roughly double the 337 | # memory usage. The cache size is given by this formula: 338 | # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 339 | # corresponding to a cache size of 2^16 = 65536 symbols. 340 | 341 | SYMBOL_CACHE_SIZE = 0 342 | 343 | # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 344 | # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 345 | # their name and scope. Since this can be an expensive process and often the 346 | # same symbol appear multiple times in the code, doxygen keeps a cache of 347 | # pre-resolved symbols. If the cache is too small doxygen will become slower. 348 | # If the cache is too large, memory is wasted. The cache size is given by this 349 | # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 350 | # corresponding to a cache size of 2^16 = 65536 symbols. 351 | 352 | LOOKUP_CACHE_SIZE = 0 353 | 354 | #--------------------------------------------------------------------------- 355 | # Build related configuration options 356 | #--------------------------------------------------------------------------- 357 | 358 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 359 | # documentation are documented, even if no documentation was available. 360 | # Private class members and static file members will be hidden unless 361 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 362 | 363 | EXTRACT_ALL = NO 364 | 365 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 366 | # will be included in the documentation. 367 | 368 | EXTRACT_PRIVATE = NO 369 | 370 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 371 | # scope will be included in the documentation. 372 | 373 | EXTRACT_PACKAGE = NO 374 | 375 | # If the EXTRACT_STATIC tag is set to YES all static members of a file 376 | # will be included in the documentation. 377 | 378 | EXTRACT_STATIC = NO 379 | 380 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 381 | # defined locally in source files will be included in the documentation. 382 | # If set to NO only classes defined in header files are included. 383 | 384 | EXTRACT_LOCAL_CLASSES = YES 385 | 386 | # This flag is only useful for Objective-C code. When set to YES local 387 | # methods, which are defined in the implementation section but not in 388 | # the interface are included in the documentation. 389 | # If set to NO (the default) only methods in the interface are included. 390 | 391 | EXTRACT_LOCAL_METHODS = NO 392 | 393 | # If this flag is set to YES, the members of anonymous namespaces will be 394 | # extracted and appear in the documentation as a namespace called 395 | # 'anonymous_namespace{file}', where file will be replaced with the base 396 | # name of the file that contains the anonymous namespace. By default 397 | # anonymous namespaces are hidden. 398 | 399 | EXTRACT_ANON_NSPACES = NO 400 | 401 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 402 | # undocumented members of documented classes, files or namespaces. 403 | # If set to NO (the default) these members will be included in the 404 | # various overviews, but no documentation section is generated. 405 | # This option has no effect if EXTRACT_ALL is enabled. 406 | 407 | HIDE_UNDOC_MEMBERS = NO 408 | 409 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 410 | # undocumented classes that are normally visible in the class hierarchy. 411 | # If set to NO (the default) these classes will be included in the various 412 | # overviews. This option has no effect if EXTRACT_ALL is enabled. 413 | 414 | HIDE_UNDOC_CLASSES = NO 415 | 416 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 417 | # friend (class|struct|union) declarations. 418 | # If set to NO (the default) these declarations will be included in the 419 | # documentation. 420 | 421 | HIDE_FRIEND_COMPOUNDS = NO 422 | 423 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 424 | # documentation blocks found inside the body of a function. 425 | # If set to NO (the default) these blocks will be appended to the 426 | # function's detailed documentation block. 427 | 428 | HIDE_IN_BODY_DOCS = NO 429 | 430 | # The INTERNAL_DOCS tag determines if documentation 431 | # that is typed after a \internal command is included. If the tag is set 432 | # to NO (the default) then the documentation will be excluded. 433 | # Set it to YES to include the internal documentation. 434 | 435 | INTERNAL_DOCS = NO 436 | 437 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 438 | # file names in lower-case letters. If set to YES upper-case letters are also 439 | # allowed. This is useful if you have classes or files whose names only differ 440 | # in case and if your file system supports case sensitive file names. Windows 441 | # and Mac users are advised to set this option to NO. 442 | 443 | CASE_SENSE_NAMES = NO 444 | 445 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 446 | # will show members with their full class and namespace scopes in the 447 | # documentation. If set to YES the scope will be hidden. 448 | 449 | HIDE_SCOPE_NAMES = NO 450 | 451 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 452 | # will put a list of the files that are included by a file in the documentation 453 | # of that file. 454 | 455 | SHOW_INCLUDE_FILES = YES 456 | 457 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 458 | # will list include files with double quotes in the documentation 459 | # rather than with sharp brackets. 460 | 461 | FORCE_LOCAL_INCLUDES = NO 462 | 463 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 464 | # is inserted in the documentation for inline members. 465 | 466 | INLINE_INFO = YES 467 | 468 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 469 | # will sort the (detailed) documentation of file and class members 470 | # alphabetically by member name. If set to NO the members will appear in 471 | # declaration order. 472 | 473 | SORT_MEMBER_DOCS = YES 474 | 475 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 476 | # brief documentation of file, namespace and class members alphabetically 477 | # by member name. If set to NO (the default) the members will appear in 478 | # declaration order. 479 | 480 | SORT_BRIEF_DOCS = NO 481 | 482 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 483 | # will sort the (brief and detailed) documentation of class members so that 484 | # constructors and destructors are listed first. If set to NO (the default) 485 | # the constructors will appear in the respective orders defined by 486 | # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 487 | # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 488 | # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 489 | 490 | SORT_MEMBERS_CTORS_1ST = NO 491 | 492 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 493 | # hierarchy of group names into alphabetical order. If set to NO (the default) 494 | # the group names will appear in their defined order. 495 | 496 | SORT_GROUP_NAMES = NO 497 | 498 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 499 | # sorted by fully-qualified names, including namespaces. If set to 500 | # NO (the default), the class list will be sorted only by class name, 501 | # not including the namespace part. 502 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 503 | # Note: This option applies only to the class list, not to the 504 | # alphabetical list. 505 | 506 | SORT_BY_SCOPE_NAME = NO 507 | 508 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 509 | # do proper type resolution of all parameters of a function it will reject a 510 | # match between the prototype and the implementation of a member function even 511 | # if there is only one candidate or it is obvious which candidate to choose 512 | # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 513 | # will still accept a match between prototype and implementation in such cases. 514 | 515 | STRICT_PROTO_MATCHING = NO 516 | 517 | # The GENERATE_TODOLIST tag can be used to enable (YES) or 518 | # disable (NO) the todo list. This list is created by putting \todo 519 | # commands in the documentation. 520 | 521 | GENERATE_TODOLIST = YES 522 | 523 | # The GENERATE_TESTLIST tag can be used to enable (YES) or 524 | # disable (NO) the test list. This list is created by putting \test 525 | # commands in the documentation. 526 | 527 | GENERATE_TESTLIST = YES 528 | 529 | # The GENERATE_BUGLIST tag can be used to enable (YES) or 530 | # disable (NO) the bug list. This list is created by putting \bug 531 | # commands in the documentation. 532 | 533 | GENERATE_BUGLIST = YES 534 | 535 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 536 | # disable (NO) the deprecated list. This list is created by putting 537 | # \deprecated commands in the documentation. 538 | 539 | GENERATE_DEPRECATEDLIST= YES 540 | 541 | # The ENABLED_SECTIONS tag can be used to enable conditional 542 | # documentation sections, marked by \if sectionname ... \endif. 543 | 544 | ENABLED_SECTIONS = 545 | 546 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 547 | # the initial value of a variable or macro consists of for it to appear in 548 | # the documentation. If the initializer consists of more lines than specified 549 | # here it will be hidden. Use a value of 0 to hide initializers completely. 550 | # The appearance of the initializer of individual variables and macros in the 551 | # documentation can be controlled using \showinitializer or \hideinitializer 552 | # command in the documentation regardless of this setting. 553 | 554 | MAX_INITIALIZER_LINES = 30 555 | 556 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 557 | # at the bottom of the documentation of classes and structs. If set to YES the 558 | # list will mention the files that were used to generate the documentation. 559 | 560 | SHOW_USED_FILES = YES 561 | 562 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 563 | # This will remove the Files entry from the Quick Index and from the 564 | # Folder Tree View (if specified). The default is YES. 565 | 566 | SHOW_FILES = YES 567 | 568 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 569 | # Namespaces page. 570 | # This will remove the Namespaces entry from the Quick Index 571 | # and from the Folder Tree View (if specified). The default is YES. 572 | 573 | SHOW_NAMESPACES = YES 574 | 575 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 576 | # doxygen should invoke to get the current version for each file (typically from 577 | # the version control system). Doxygen will invoke the program by executing (via 578 | # popen()) the command , where is the value of 579 | # the FILE_VERSION_FILTER tag, and is the name of an input file 580 | # provided by doxygen. Whatever the program writes to standard output 581 | # is used as the file version. See the manual for examples. 582 | 583 | FILE_VERSION_FILTER = 584 | 585 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 586 | # by doxygen. The layout file controls the global structure of the generated 587 | # output files in an output format independent way. To create the layout file 588 | # that represents doxygen's defaults, run doxygen with the -l option. 589 | # You can optionally specify a file name after the option, if omitted 590 | # DoxygenLayout.xml will be used as the name of the layout file. 591 | 592 | LAYOUT_FILE = 593 | 594 | # The CITE_BIB_FILES tag can be used to specify one or more bib files 595 | # containing the references data. This must be a list of .bib files. The 596 | # .bib extension is automatically appended if omitted. Using this command 597 | # requires the bibtex tool to be installed. See also 598 | # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 599 | # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 600 | # feature you need bibtex and perl available in the search path. 601 | 602 | CITE_BIB_FILES = 603 | 604 | #--------------------------------------------------------------------------- 605 | # configuration options related to warning and progress messages 606 | #--------------------------------------------------------------------------- 607 | 608 | # The QUIET tag can be used to turn on/off the messages that are generated 609 | # by doxygen. Possible values are YES and NO. If left blank NO is used. 610 | 611 | QUIET = NO 612 | 613 | # The WARNINGS tag can be used to turn on/off the warning messages that are 614 | # generated by doxygen. Possible values are YES and NO. If left blank 615 | # NO is used. 616 | 617 | WARNINGS = YES 618 | 619 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 620 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 621 | # automatically be disabled. 622 | 623 | WARN_IF_UNDOCUMENTED = YES 624 | 625 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 626 | # potential errors in the documentation, such as not documenting some 627 | # parameters in a documented function, or documenting parameters that 628 | # don't exist or using markup commands wrongly. 629 | 630 | WARN_IF_DOC_ERROR = YES 631 | 632 | # The WARN_NO_PARAMDOC option can be enabled to get warnings for 633 | # functions that are documented, but have no documentation for their parameters 634 | # or return value. If set to NO (the default) doxygen will only warn about 635 | # wrong or incomplete parameter documentation, but not about the absence of 636 | # documentation. 637 | 638 | WARN_NO_PARAMDOC = NO 639 | 640 | # The WARN_FORMAT tag determines the format of the warning messages that 641 | # doxygen can produce. The string should contain the $file, $line, and $text 642 | # tags, which will be replaced by the file and line number from which the 643 | # warning originated and the warning text. Optionally the format may contain 644 | # $version, which will be replaced by the version of the file (if it could 645 | # be obtained via FILE_VERSION_FILTER) 646 | 647 | WARN_FORMAT = "$file:$line: $text" 648 | 649 | # The WARN_LOGFILE tag can be used to specify a file to which warning 650 | # and error messages should be written. If left blank the output is written 651 | # to stderr. 652 | 653 | WARN_LOGFILE = 654 | 655 | #--------------------------------------------------------------------------- 656 | # configuration options related to the input files 657 | #--------------------------------------------------------------------------- 658 | 659 | # The INPUT tag can be used to specify the files and/or directories that contain 660 | # documented source files. You may enter file names like "myfile.cpp" or 661 | # directories like "/usr/src/myproject". Separate the files or directories 662 | # with spaces. 663 | 664 | INPUT = include/array.h README.md 665 | 666 | # This tag can be used to specify the character encoding of the source files 667 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 668 | # also the default input encoding. Doxygen uses libiconv (or the iconv built 669 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 670 | # the list of possible encodings. 671 | 672 | INPUT_ENCODING = UTF-8 673 | 674 | # If the value of the INPUT tag contains directories, you can use the 675 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 676 | # and *.h) to filter out the source-files in the directories. If left 677 | # blank the following patterns are tested: 678 | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 679 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 680 | # *.f90 *.f *.for *.vhd *.vhdl 681 | 682 | FILE_PATTERNS = 683 | 684 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories 685 | # should be searched for input files as well. Possible values are YES and NO. 686 | # If left blank NO is used. 687 | 688 | RECURSIVE = NO 689 | 690 | # The EXCLUDE tag can be used to specify files and/or directories that should be 691 | # excluded from the INPUT source files. This way you can easily exclude a 692 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 693 | # Note that relative paths are relative to the directory from which doxygen is 694 | # run. 695 | 696 | EXCLUDE = 697 | 698 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 699 | # directories that are symbolic links (a Unix file system feature) are excluded 700 | # from the input. 701 | 702 | EXCLUDE_SYMLINKS = NO 703 | 704 | # If the value of the INPUT tag contains directories, you can use the 705 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 706 | # certain files from those directories. Note that the wildcards are matched 707 | # against the file with absolute path, so to exclude all test directories 708 | # for example use the pattern */test/* 709 | 710 | EXCLUDE_PATTERNS = 711 | 712 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 713 | # (namespaces, classes, functions, etc.) that should be excluded from the 714 | # output. The symbol name can be a fully qualified name, a word, or if the 715 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 716 | # AClass::ANamespace, ANamespace::*Test 717 | 718 | EXCLUDE_SYMBOLS = 719 | 720 | # The EXAMPLE_PATH tag can be used to specify one or more files or 721 | # directories that contain example code fragments that are included (see 722 | # the \include command). 723 | 724 | EXAMPLE_PATH = 725 | 726 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 727 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 728 | # and *.h) to filter out the source-files in the directories. If left 729 | # blank all files are included. 730 | 731 | EXAMPLE_PATTERNS = 732 | 733 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 734 | # searched for input files to be used with the \include or \dontinclude 735 | # commands irrespective of the value of the RECURSIVE tag. 736 | # Possible values are YES and NO. If left blank NO is used. 737 | 738 | EXAMPLE_RECURSIVE = NO 739 | 740 | # The IMAGE_PATH tag can be used to specify one or more files or 741 | # directories that contain image that are included in the documentation (see 742 | # the \image command). 743 | 744 | IMAGE_PATH = 745 | 746 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 747 | # invoke to filter for each input file. Doxygen will invoke the filter program 748 | # by executing (via popen()) the command , where 749 | # is the value of the INPUT_FILTER tag, and is the name of an 750 | # input file. Doxygen will then use the output that the filter program writes 751 | # to standard output. 752 | # If FILTER_PATTERNS is specified, this tag will be 753 | # ignored. 754 | 755 | INPUT_FILTER = 756 | 757 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 758 | # basis. 759 | # Doxygen will compare the file name with each pattern and apply the 760 | # filter if there is a match. 761 | # The filters are a list of the form: 762 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 763 | # info on how filters are used. If FILTER_PATTERNS is empty or if 764 | # non of the patterns match the file name, INPUT_FILTER is applied. 765 | 766 | FILTER_PATTERNS = 767 | 768 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 769 | # INPUT_FILTER) will be used to filter the input files when producing source 770 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). 771 | 772 | FILTER_SOURCE_FILES = NO 773 | 774 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 775 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 776 | # and it is also possible to disable source filtering for a specific pattern 777 | # using *.ext= (so without naming a filter). This option only has effect when 778 | # FILTER_SOURCE_FILES is enabled. 779 | 780 | FILTER_SOURCE_PATTERNS = 781 | 782 | #--------------------------------------------------------------------------- 783 | # configuration options related to source browsing 784 | #--------------------------------------------------------------------------- 785 | 786 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will 787 | # be generated. Documented entities will be cross-referenced with these sources. 788 | # Note: To get rid of all source code in the generated output, make sure also 789 | # VERBATIM_HEADERS is set to NO. 790 | 791 | SOURCE_BROWSER = NO 792 | 793 | # Setting the INLINE_SOURCES tag to YES will include the body 794 | # of functions and classes directly in the documentation. 795 | 796 | INLINE_SOURCES = NO 797 | 798 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 799 | # doxygen to hide any special comment blocks from generated source code 800 | # fragments. Normal C, C++ and Fortran comments will always remain visible. 801 | 802 | STRIP_CODE_COMMENTS = YES 803 | 804 | # If the REFERENCED_BY_RELATION tag is set to YES 805 | # then for each documented function all documented 806 | # functions referencing it will be listed. 807 | 808 | REFERENCED_BY_RELATION = NO 809 | 810 | # If the REFERENCES_RELATION tag is set to YES 811 | # then for each documented function all documented entities 812 | # called/used by that function will be listed. 813 | 814 | REFERENCES_RELATION = NO 815 | 816 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 817 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 818 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 819 | # link to the source code. 820 | # Otherwise they will link to the documentation. 821 | 822 | REFERENCES_LINK_SOURCE = YES 823 | 824 | # If the USE_HTAGS tag is set to YES then the references to source code 825 | # will point to the HTML generated by the htags(1) tool instead of doxygen 826 | # built-in source browser. The htags tool is part of GNU's global source 827 | # tagging system (see http://www.gnu.org/software/global/global.html). You 828 | # will need version 4.8.6 or higher. 829 | 830 | USE_HTAGS = NO 831 | 832 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 833 | # will generate a verbatim copy of the header file for each class for 834 | # which an include is specified. Set to NO to disable this. 835 | 836 | VERBATIM_HEADERS = YES 837 | 838 | #--------------------------------------------------------------------------- 839 | # configuration options related to the alphabetical class index 840 | #--------------------------------------------------------------------------- 841 | 842 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 843 | # of all compounds will be generated. Enable this if the project 844 | # contains a lot of classes, structs, unions or interfaces. 845 | 846 | ALPHABETICAL_INDEX = YES 847 | 848 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 849 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 850 | # in which this list will be split (can be a number in the range [1..20]) 851 | 852 | COLS_IN_ALPHA_INDEX = 5 853 | 854 | # In case all classes in a project start with a common prefix, all 855 | # classes will be put under the same header in the alphabetical index. 856 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 857 | # should be ignored while generating the index headers. 858 | 859 | IGNORE_PREFIX = 860 | 861 | #--------------------------------------------------------------------------- 862 | # configuration options related to the HTML output 863 | #--------------------------------------------------------------------------- 864 | 865 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 866 | # generate HTML output. 867 | 868 | GENERATE_HTML = YES 869 | 870 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 871 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 872 | # put in front of it. If left blank `html' will be used as the default path. 873 | 874 | HTML_OUTPUT = html 875 | 876 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 877 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 878 | # doxygen will generate files with .html extension. 879 | 880 | HTML_FILE_EXTENSION = .html 881 | 882 | # The HTML_HEADER tag can be used to specify a personal HTML header for 883 | # each generated HTML page. If it is left blank doxygen will generate a 884 | # standard header. Note that when using a custom header you are responsible 885 | # for the proper inclusion of any scripts and style sheets that doxygen 886 | # needs, which is dependent on the configuration options used. 887 | # It is advised to generate a default header using "doxygen -w html 888 | # header.html footer.html stylesheet.css YourConfigFile" and then modify 889 | # that header. Note that the header is subject to change so you typically 890 | # have to redo this when upgrading to a newer version of doxygen or when 891 | # changing the value of configuration settings such as GENERATE_TREEVIEW! 892 | 893 | HTML_HEADER = 894 | 895 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for 896 | # each generated HTML page. If it is left blank doxygen will generate a 897 | # standard footer. 898 | 899 | HTML_FOOTER = 900 | 901 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 902 | # style sheet that is used by each HTML page. It can be used to 903 | # fine-tune the look of the HTML output. If left blank doxygen will 904 | # generate a default style sheet. Note that it is recommended to use 905 | # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 906 | # tag will in the future become obsolete. 907 | 908 | HTML_STYLESHEET = 909 | 910 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 911 | # user-defined cascading style sheet that is included after the standard 912 | # style sheets created by doxygen. Using this option one can overrule 913 | # certain style aspects. This is preferred over using HTML_STYLESHEET 914 | # since it does not replace the standard style sheet and is therefor more 915 | # robust against future updates. Doxygen will copy the style sheet file to 916 | # the output directory. 917 | 918 | HTML_EXTRA_STYLESHEET = 919 | 920 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 921 | # other source files which should be copied to the HTML output directory. Note 922 | # that these files will be copied to the base HTML output directory. Use the 923 | # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 924 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that 925 | # the files will be copied as-is; there are no commands or markers available. 926 | 927 | HTML_EXTRA_FILES = 928 | 929 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 930 | # Doxygen will adjust the colors in the style sheet and background images 931 | # according to this color. Hue is specified as an angle on a colorwheel, 932 | # see http://en.wikipedia.org/wiki/Hue for more information. 933 | # For instance the value 0 represents red, 60 is yellow, 120 is green, 934 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 935 | # The allowed range is 0 to 359. 936 | 937 | HTML_COLORSTYLE_HUE = 220 938 | 939 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 940 | # the colors in the HTML output. For a value of 0 the output will use 941 | # grayscales only. A value of 255 will produce the most vivid colors. 942 | 943 | HTML_COLORSTYLE_SAT = 100 944 | 945 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 946 | # the luminance component of the colors in the HTML output. Values below 947 | # 100 gradually make the output lighter, whereas values above 100 make 948 | # the output darker. The value divided by 100 is the actual gamma applied, 949 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 950 | # and 100 does not change the gamma. 951 | 952 | HTML_COLORSTYLE_GAMMA = 80 953 | 954 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 955 | # page will contain the date and time when the page was generated. Setting 956 | # this to NO can help when comparing the output of multiple runs. 957 | 958 | HTML_TIMESTAMP = YES 959 | 960 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 961 | # documentation will contain sections that can be hidden and shown after the 962 | # page has loaded. 963 | 964 | HTML_DYNAMIC_SECTIONS = NO 965 | 966 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 967 | # entries shown in the various tree structured indices initially; the user 968 | # can expand and collapse entries dynamically later on. Doxygen will expand 969 | # the tree to such a level that at most the specified number of entries are 970 | # visible (unless a fully collapsed tree already exceeds this amount). 971 | # So setting the number of entries 1 will produce a full collapsed tree by 972 | # default. 0 is a special value representing an infinite number of entries 973 | # and will result in a full expanded tree by default. 974 | 975 | HTML_INDEX_NUM_ENTRIES = 100 976 | 977 | # If the GENERATE_DOCSET tag is set to YES, additional index files 978 | # will be generated that can be used as input for Apple's Xcode 3 979 | # integrated development environment, introduced with OSX 10.5 (Leopard). 980 | # To create a documentation set, doxygen will generate a Makefile in the 981 | # HTML output directory. Running make will produce the docset in that 982 | # directory and running "make install" will install the docset in 983 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 984 | # it at startup. 985 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 986 | # for more information. 987 | 988 | GENERATE_DOCSET = NO 989 | 990 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 991 | # feed. A documentation feed provides an umbrella under which multiple 992 | # documentation sets from a single provider (such as a company or product suite) 993 | # can be grouped. 994 | 995 | DOCSET_FEEDNAME = "Doxygen generated docs" 996 | 997 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 998 | # should uniquely identify the documentation set bundle. This should be a 999 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1000 | # will append .docset to the name. 1001 | 1002 | DOCSET_BUNDLE_ID = org.doxygen.Project 1003 | 1004 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 1005 | # identify the documentation publisher. This should be a reverse domain-name 1006 | # style string, e.g. com.mycompany.MyDocSet.documentation. 1007 | 1008 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1009 | 1010 | # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1011 | 1012 | DOCSET_PUBLISHER_NAME = Publisher 1013 | 1014 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files 1015 | # will be generated that can be used as input for tools like the 1016 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1017 | # of the generated HTML documentation. 1018 | 1019 | GENERATE_HTMLHELP = NO 1020 | 1021 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1022 | # be used to specify the file name of the resulting .chm file. You 1023 | # can add a path in front of the file if the result should not be 1024 | # written to the html output directory. 1025 | 1026 | CHM_FILE = 1027 | 1028 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1029 | # be used to specify the location (absolute path including file name) of 1030 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1031 | # the HTML help compiler on the generated index.hhp. 1032 | 1033 | HHC_LOCATION = 1034 | 1035 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1036 | # controls if a separate .chi index file is generated (YES) or that 1037 | # it should be included in the master .chm file (NO). 1038 | 1039 | GENERATE_CHI = NO 1040 | 1041 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1042 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file 1043 | # content. 1044 | 1045 | CHM_INDEX_ENCODING = 1046 | 1047 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1048 | # controls whether a binary table of contents is generated (YES) or a 1049 | # normal table of contents (NO) in the .chm file. 1050 | 1051 | BINARY_TOC = NO 1052 | 1053 | # The TOC_EXPAND flag can be set to YES to add extra items for group members 1054 | # to the contents of the HTML help documentation and to the tree view. 1055 | 1056 | TOC_EXPAND = NO 1057 | 1058 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1059 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1060 | # that can be used as input for Qt's qhelpgenerator to generate a 1061 | # Qt Compressed Help (.qch) of the generated HTML documentation. 1062 | 1063 | GENERATE_QHP = NO 1064 | 1065 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1066 | # be used to specify the file name of the resulting .qch file. 1067 | # The path specified is relative to the HTML output folder. 1068 | 1069 | QCH_FILE = 1070 | 1071 | # The QHP_NAMESPACE tag specifies the namespace to use when generating 1072 | # Qt Help Project output. For more information please see 1073 | # http://doc.trolltech.com/qthelpproject.html#namespace 1074 | 1075 | QHP_NAMESPACE = org.doxygen.Project 1076 | 1077 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1078 | # Qt Help Project output. For more information please see 1079 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders 1080 | 1081 | QHP_VIRTUAL_FOLDER = doc 1082 | 1083 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1084 | # add. For more information please see 1085 | # http://doc.trolltech.com/qthelpproject.html#custom-filters 1086 | 1087 | QHP_CUST_FILTER_NAME = 1088 | 1089 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1090 | # custom filter to add. For more information please see 1091 | # 1092 | # Qt Help Project / Custom Filters. 1093 | 1094 | QHP_CUST_FILTER_ATTRS = 1095 | 1096 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1097 | # project's 1098 | # filter section matches. 1099 | # 1100 | # Qt Help Project / Filter Attributes. 1101 | 1102 | QHP_SECT_FILTER_ATTRS = 1103 | 1104 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1105 | # be used to specify the location of Qt's qhelpgenerator. 1106 | # If non-empty doxygen will try to run qhelpgenerator on the generated 1107 | # .qhp file. 1108 | 1109 | QHG_LOCATION = 1110 | 1111 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1112 | # will be generated, which together with the HTML files, form an Eclipse help 1113 | # plugin. To install this plugin and make it available under the help contents 1114 | # menu in Eclipse, the contents of the directory containing the HTML and XML 1115 | # files needs to be copied into the plugins directory of eclipse. The name of 1116 | # the directory within the plugins directory should be the same as 1117 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1118 | # the help appears. 1119 | 1120 | GENERATE_ECLIPSEHELP = NO 1121 | 1122 | # A unique identifier for the eclipse help plugin. When installing the plugin 1123 | # the directory name containing the HTML and XML files should also have 1124 | # this name. 1125 | 1126 | ECLIPSE_DOC_ID = org.doxygen.Project 1127 | 1128 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1129 | # at top of each HTML page. The value NO (the default) enables the index and 1130 | # the value YES disables it. Since the tabs have the same information as the 1131 | # navigation tree you can set this option to NO if you already set 1132 | # GENERATE_TREEVIEW to YES. 1133 | 1134 | DISABLE_INDEX = NO 1135 | 1136 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1137 | # structure should be generated to display hierarchical information. 1138 | # If the tag value is set to YES, a side panel will be generated 1139 | # containing a tree-like index structure (just like the one that 1140 | # is generated for HTML Help). For this to work a browser that supports 1141 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1142 | # Windows users are probably better off using the HTML help feature. 1143 | # Since the tree basically has the same information as the tab index you 1144 | # could consider to set DISABLE_INDEX to NO when enabling this option. 1145 | 1146 | GENERATE_TREEVIEW = NO 1147 | 1148 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1149 | # (range [0,1..20]) that doxygen will group on one line in the generated HTML 1150 | # documentation. Note that a value of 0 will completely suppress the enum 1151 | # values from appearing in the overview section. 1152 | 1153 | ENUM_VALUES_PER_LINE = 4 1154 | 1155 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1156 | # used to set the initial width (in pixels) of the frame in which the tree 1157 | # is shown. 1158 | 1159 | TREEVIEW_WIDTH = 250 1160 | 1161 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1162 | # links to external symbols imported via tag files in a separate window. 1163 | 1164 | EXT_LINKS_IN_WINDOW = NO 1165 | 1166 | # Use this tag to change the font size of Latex formulas included 1167 | # as images in the HTML documentation. The default is 10. Note that 1168 | # when you change the font size after a successful doxygen run you need 1169 | # to manually remove any form_*.png images from the HTML output directory 1170 | # to force them to be regenerated. 1171 | 1172 | FORMULA_FONTSIZE = 10 1173 | 1174 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1175 | # generated for formulas are transparent PNGs. Transparent PNGs are 1176 | # not supported properly for IE 6.0, but are supported on all modern browsers. 1177 | # Note that when changing this option you need to delete any form_*.png files 1178 | # in the HTML output before the changes have effect. 1179 | 1180 | FORMULA_TRANSPARENT = YES 1181 | 1182 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1183 | # (see http://www.mathjax.org) which uses client side Javascript for the 1184 | # rendering instead of using prerendered bitmaps. Use this if you do not 1185 | # have LaTeX installed or if you want to formulas look prettier in the HTML 1186 | # output. When enabled you may also need to install MathJax separately and 1187 | # configure the path to it using the MATHJAX_RELPATH option. 1188 | 1189 | USE_MATHJAX = NO 1190 | 1191 | # When MathJax is enabled you need to specify the location relative to the 1192 | # HTML output directory using the MATHJAX_RELPATH option. The destination 1193 | # directory should contain the MathJax.js script. For instance, if the mathjax 1194 | # directory is located at the same level as the HTML output directory, then 1195 | # MATHJAX_RELPATH should be ../mathjax. The default value points to 1196 | # the MathJax Content Delivery Network so you can quickly see the result without 1197 | # installing MathJax. 1198 | # However, it is strongly recommended to install a local 1199 | # copy of MathJax from http://www.mathjax.org before deployment. 1200 | 1201 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1202 | 1203 | # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1204 | # names that should be enabled during MathJax rendering. 1205 | 1206 | MATHJAX_EXTENSIONS = 1207 | 1208 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box 1209 | # for the HTML output. The underlying search engine uses javascript 1210 | # and DHTML and should work on any modern browser. Note that when using 1211 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1212 | # (GENERATE_DOCSET) there is already a search function so this one should 1213 | # typically be disabled. For large projects the javascript based search engine 1214 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1215 | 1216 | SEARCHENGINE = YES 1217 | 1218 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1219 | # implemented using a PHP enabled web server instead of at the web client 1220 | # using Javascript. Doxygen will generate the search PHP script and index 1221 | # file to put on the web server. The advantage of the server 1222 | # based approach is that it scales better to large projects and allows 1223 | # full text search. The disadvantages are that it is more difficult to setup 1224 | # and does not have live searching capabilities. 1225 | 1226 | SERVER_BASED_SEARCH = NO 1227 | 1228 | #--------------------------------------------------------------------------- 1229 | # configuration options related to the LaTeX output 1230 | #--------------------------------------------------------------------------- 1231 | 1232 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1233 | # generate Latex output. 1234 | 1235 | GENERATE_LATEX = YES 1236 | 1237 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1238 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1239 | # put in front of it. If left blank `latex' will be used as the default path. 1240 | 1241 | LATEX_OUTPUT = latex 1242 | 1243 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1244 | # invoked. If left blank `latex' will be used as the default command name. 1245 | # Note that when enabling USE_PDFLATEX this option is only used for 1246 | # generating bitmaps for formulas in the HTML output, but not in the 1247 | # Makefile that is written to the output directory. 1248 | 1249 | LATEX_CMD_NAME = latex 1250 | 1251 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1252 | # generate index for LaTeX. If left blank `makeindex' will be used as the 1253 | # default command name. 1254 | 1255 | MAKEINDEX_CMD_NAME = makeindex 1256 | 1257 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1258 | # LaTeX documents. This may be useful for small projects and may help to 1259 | # save some trees in general. 1260 | 1261 | COMPACT_LATEX = NO 1262 | 1263 | # The PAPER_TYPE tag can be used to set the paper type that is used 1264 | # by the printer. Possible values are: a4, letter, legal and 1265 | # executive. If left blank a4wide will be used. 1266 | 1267 | PAPER_TYPE = a4 1268 | 1269 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1270 | # packages that should be included in the LaTeX output. 1271 | 1272 | EXTRA_PACKAGES = 1273 | 1274 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1275 | # the generated latex document. The header should contain everything until 1276 | # the first chapter. If it is left blank doxygen will generate a 1277 | # standard header. Notice: only use this tag if you know what you are doing! 1278 | 1279 | LATEX_HEADER = 1280 | 1281 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1282 | # the generated latex document. The footer should contain everything after 1283 | # the last chapter. If it is left blank doxygen will generate a 1284 | # standard footer. Notice: only use this tag if you know what you are doing! 1285 | 1286 | LATEX_FOOTER = 1287 | 1288 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1289 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1290 | # contain links (just like the HTML output) instead of page references 1291 | # This makes the output suitable for online browsing using a pdf viewer. 1292 | 1293 | PDF_HYPERLINKS = YES 1294 | 1295 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1296 | # plain latex in the generated Makefile. Set this option to YES to get a 1297 | # higher quality PDF documentation. 1298 | 1299 | USE_PDFLATEX = YES 1300 | 1301 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1302 | # command to the generated LaTeX files. This will instruct LaTeX to keep 1303 | # running if errors occur, instead of asking the user for help. 1304 | # This option is also used when generating formulas in HTML. 1305 | 1306 | LATEX_BATCHMODE = NO 1307 | 1308 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1309 | # include the index chapters (such as File Index, Compound Index, etc.) 1310 | # in the output. 1311 | 1312 | LATEX_HIDE_INDICES = NO 1313 | 1314 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include 1315 | # source code with syntax highlighting in the LaTeX output. 1316 | # Note that which sources are shown also depends on other settings 1317 | # such as SOURCE_BROWSER. 1318 | 1319 | LATEX_SOURCE_CODE = NO 1320 | 1321 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1322 | # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1323 | # http://en.wikipedia.org/wiki/BibTeX for more info. 1324 | 1325 | LATEX_BIB_STYLE = plain 1326 | 1327 | #--------------------------------------------------------------------------- 1328 | # configuration options related to the RTF output 1329 | #--------------------------------------------------------------------------- 1330 | 1331 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1332 | # The RTF output is optimized for Word 97 and may not look very pretty with 1333 | # other RTF readers or editors. 1334 | 1335 | GENERATE_RTF = NO 1336 | 1337 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1338 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1339 | # put in front of it. If left blank `rtf' will be used as the default path. 1340 | 1341 | RTF_OUTPUT = rtf 1342 | 1343 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1344 | # RTF documents. This may be useful for small projects and may help to 1345 | # save some trees in general. 1346 | 1347 | COMPACT_RTF = NO 1348 | 1349 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1350 | # will contain hyperlink fields. The RTF file will 1351 | # contain links (just like the HTML output) instead of page references. 1352 | # This makes the output suitable for online browsing using WORD or other 1353 | # programs which support those fields. 1354 | # Note: wordpad (write) and others do not support links. 1355 | 1356 | RTF_HYPERLINKS = NO 1357 | 1358 | # Load style sheet definitions from file. Syntax is similar to doxygen's 1359 | # config file, i.e. a series of assignments. You only have to provide 1360 | # replacements, missing definitions are set to their default value. 1361 | 1362 | RTF_STYLESHEET_FILE = 1363 | 1364 | # Set optional variables used in the generation of an rtf document. 1365 | # Syntax is similar to doxygen's config file. 1366 | 1367 | RTF_EXTENSIONS_FILE = 1368 | 1369 | #--------------------------------------------------------------------------- 1370 | # configuration options related to the man page output 1371 | #--------------------------------------------------------------------------- 1372 | 1373 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1374 | # generate man pages 1375 | 1376 | GENERATE_MAN = NO 1377 | 1378 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1379 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1380 | # put in front of it. If left blank `man' will be used as the default path. 1381 | 1382 | MAN_OUTPUT = man 1383 | 1384 | # The MAN_EXTENSION tag determines the extension that is added to 1385 | # the generated man pages (default is the subroutine's section .3) 1386 | 1387 | MAN_EXTENSION = .3 1388 | 1389 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1390 | # then it will generate one additional man file for each entity 1391 | # documented in the real man page(s). These additional files 1392 | # only source the real man page, but without them the man command 1393 | # would be unable to find the correct page. The default is NO. 1394 | 1395 | MAN_LINKS = NO 1396 | 1397 | #--------------------------------------------------------------------------- 1398 | # configuration options related to the XML output 1399 | #--------------------------------------------------------------------------- 1400 | 1401 | # If the GENERATE_XML tag is set to YES Doxygen will 1402 | # generate an XML file that captures the structure of 1403 | # the code including all documentation. 1404 | 1405 | GENERATE_XML = NO 1406 | 1407 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1408 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1409 | # put in front of it. If left blank `xml' will be used as the default path. 1410 | 1411 | XML_OUTPUT = xml 1412 | 1413 | # The XML_SCHEMA tag can be used to specify an XML schema, 1414 | # which can be used by a validating XML parser to check the 1415 | # syntax of the XML files. 1416 | 1417 | XML_SCHEMA = 1418 | 1419 | # The XML_DTD tag can be used to specify an XML DTD, 1420 | # which can be used by a validating XML parser to check the 1421 | # syntax of the XML files. 1422 | 1423 | XML_DTD = 1424 | 1425 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1426 | # dump the program listings (including syntax highlighting 1427 | # and cross-referencing information) to the XML output. Note that 1428 | # enabling this will significantly increase the size of the XML output. 1429 | 1430 | XML_PROGRAMLISTING = YES 1431 | 1432 | #--------------------------------------------------------------------------- 1433 | # configuration options for the AutoGen Definitions output 1434 | #--------------------------------------------------------------------------- 1435 | 1436 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1437 | # generate an AutoGen Definitions (see autogen.sf.net) file 1438 | # that captures the structure of the code including all 1439 | # documentation. Note that this feature is still experimental 1440 | # and incomplete at the moment. 1441 | 1442 | GENERATE_AUTOGEN_DEF = NO 1443 | 1444 | #--------------------------------------------------------------------------- 1445 | # configuration options related to the Perl module output 1446 | #--------------------------------------------------------------------------- 1447 | 1448 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1449 | # generate a Perl module file that captures the structure of 1450 | # the code including all documentation. Note that this 1451 | # feature is still experimental and incomplete at the 1452 | # moment. 1453 | 1454 | GENERATE_PERLMOD = NO 1455 | 1456 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1457 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1458 | # to generate PDF and DVI output from the Perl module output. 1459 | 1460 | PERLMOD_LATEX = NO 1461 | 1462 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1463 | # nicely formatted so it can be parsed by a human reader. 1464 | # This is useful 1465 | # if you want to understand what is going on. 1466 | # On the other hand, if this 1467 | # tag is set to NO the size of the Perl module output will be much smaller 1468 | # and Perl will parse it just the same. 1469 | 1470 | PERLMOD_PRETTY = YES 1471 | 1472 | # The names of the make variables in the generated doxyrules.make file 1473 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1474 | # This is useful so different doxyrules.make files included by the same 1475 | # Makefile don't overwrite each other's variables. 1476 | 1477 | PERLMOD_MAKEVAR_PREFIX = 1478 | 1479 | #--------------------------------------------------------------------------- 1480 | # Configuration options related to the preprocessor 1481 | #--------------------------------------------------------------------------- 1482 | 1483 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1484 | # evaluate all C-preprocessor directives found in the sources and include 1485 | # files. 1486 | 1487 | ENABLE_PREPROCESSING = YES 1488 | 1489 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1490 | # names in the source code. If set to NO (the default) only conditional 1491 | # compilation will be performed. Macro expansion can be done in a controlled 1492 | # way by setting EXPAND_ONLY_PREDEF to YES. 1493 | 1494 | MACRO_EXPANSION = NO 1495 | 1496 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1497 | # then the macro expansion is limited to the macros specified with the 1498 | # PREDEFINED and EXPAND_AS_DEFINED tags. 1499 | 1500 | EXPAND_ONLY_PREDEF = NO 1501 | 1502 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1503 | # pointed to by INCLUDE_PATH will be searched when a #include is found. 1504 | 1505 | SEARCH_INCLUDES = YES 1506 | 1507 | # The INCLUDE_PATH tag can be used to specify one or more directories that 1508 | # contain include files that are not input files but should be processed by 1509 | # the preprocessor. 1510 | 1511 | INCLUDE_PATH = 1512 | 1513 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1514 | # patterns (like *.h and *.hpp) to filter out the header-files in the 1515 | # directories. If left blank, the patterns specified with FILE_PATTERNS will 1516 | # be used. 1517 | 1518 | INCLUDE_FILE_PATTERNS = 1519 | 1520 | # The PREDEFINED tag can be used to specify one or more macro names that 1521 | # are defined before the preprocessor is started (similar to the -D option of 1522 | # gcc). The argument of the tag is a list of macros of the form: name 1523 | # or name=definition (no spaces). If the definition and the = are 1524 | # omitted =1 is assumed. To prevent a macro definition from being 1525 | # undefined via #undef or recursively expanded use the := operator 1526 | # instead of the = operator. 1527 | 1528 | PREDEFINED = 1529 | 1530 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1531 | # this tag can be used to specify a list of macro names that should be expanded. 1532 | # The macro definition that is found in the sources will be used. 1533 | # Use the PREDEFINED tag if you want to use a different macro definition that 1534 | # overrules the definition found in the source code. 1535 | 1536 | EXPAND_AS_DEFINED = 1537 | 1538 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1539 | # doxygen's preprocessor will remove all references to function-like macros 1540 | # that are alone on a line, have an all uppercase name, and do not end with a 1541 | # semicolon, because these will confuse the parser if not removed. 1542 | 1543 | SKIP_FUNCTION_MACROS = YES 1544 | 1545 | #--------------------------------------------------------------------------- 1546 | # Configuration::additions related to external references 1547 | #--------------------------------------------------------------------------- 1548 | 1549 | # The TAGFILES option can be used to specify one or more tagfiles. For each 1550 | # tag file the location of the external documentation should be added. The 1551 | # format of a tag file without this location is as follows: 1552 | # 1553 | # TAGFILES = file1 file2 ... 1554 | # Adding location for the tag files is done as follows: 1555 | # 1556 | # TAGFILES = file1=loc1 "file2 = loc2" ... 1557 | # where "loc1" and "loc2" can be relative or absolute paths 1558 | # or URLs. Note that each tag file must have a unique name (where the name does 1559 | # NOT include the path). If a tag file is not located in the directory in which 1560 | # doxygen is run, you must also specify the path to the tagfile here. 1561 | 1562 | TAGFILES = 1563 | 1564 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1565 | # a tag file that is based on the input files it reads. 1566 | 1567 | GENERATE_TAGFILE = 1568 | 1569 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1570 | # in the class index. If set to NO only the inherited external classes 1571 | # will be listed. 1572 | 1573 | ALLEXTERNALS = NO 1574 | 1575 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1576 | # in the modules index. If set to NO, only the current project's groups will 1577 | # be listed. 1578 | 1579 | EXTERNAL_GROUPS = YES 1580 | 1581 | # The PERL_PATH should be the absolute path and name of the perl script 1582 | # interpreter (i.e. the result of `which perl'). 1583 | 1584 | PERL_PATH = /usr/bin/perl 1585 | 1586 | #--------------------------------------------------------------------------- 1587 | # Configuration options related to the dot tool 1588 | #--------------------------------------------------------------------------- 1589 | 1590 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1591 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1592 | # or super classes. Setting the tag to NO turns the diagrams off. Note that 1593 | # this option also works with HAVE_DOT disabled, but it is recommended to 1594 | # install and use dot, since it yields more powerful graphs. 1595 | 1596 | CLASS_DIAGRAMS = YES 1597 | 1598 | # You can define message sequence charts within doxygen comments using the \msc 1599 | # command. Doxygen will then run the mscgen tool (see 1600 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1601 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1602 | # the mscgen tool resides. If left empty the tool is assumed to be found in the 1603 | # default search path. 1604 | 1605 | MSCGEN_PATH = 1606 | 1607 | # If set to YES, the inheritance and collaboration graphs will hide 1608 | # inheritance and usage relations if the target is undocumented 1609 | # or is not a class. 1610 | 1611 | HIDE_UNDOC_RELATIONS = YES 1612 | 1613 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1614 | # available from the path. This tool is part of Graphviz, a graph visualization 1615 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1616 | # have no effect if this option is set to NO (the default) 1617 | 1618 | HAVE_DOT = NO 1619 | 1620 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1621 | # allowed to run in parallel. When set to 0 (the default) doxygen will 1622 | # base this on the number of processors available in the system. You can set it 1623 | # explicitly to a value larger than 0 to get control over the balance 1624 | # between CPU load and processing speed. 1625 | 1626 | DOT_NUM_THREADS = 0 1627 | 1628 | # By default doxygen will use the Helvetica font for all dot files that 1629 | # doxygen generates. When you want a differently looking font you can specify 1630 | # the font name using DOT_FONTNAME. You need to make sure dot is able to find 1631 | # the font, which can be done by putting it in a standard location or by setting 1632 | # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1633 | # directory containing the font. 1634 | 1635 | DOT_FONTNAME = Helvetica 1636 | 1637 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1638 | # The default size is 10pt. 1639 | 1640 | DOT_FONTSIZE = 10 1641 | 1642 | # By default doxygen will tell dot to use the Helvetica font. 1643 | # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1644 | # set the path where dot can find it. 1645 | 1646 | DOT_FONTPATH = 1647 | 1648 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1649 | # will generate a graph for each documented class showing the direct and 1650 | # indirect inheritance relations. Setting this tag to YES will force the 1651 | # CLASS_DIAGRAMS tag to NO. 1652 | 1653 | CLASS_GRAPH = YES 1654 | 1655 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1656 | # will generate a graph for each documented class showing the direct and 1657 | # indirect implementation dependencies (inheritance, containment, and 1658 | # class references variables) of the class with other documented classes. 1659 | 1660 | COLLABORATION_GRAPH = YES 1661 | 1662 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1663 | # will generate a graph for groups, showing the direct groups dependencies 1664 | 1665 | GROUP_GRAPHS = YES 1666 | 1667 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1668 | # collaboration diagrams in a style similar to the OMG's Unified Modeling 1669 | # Language. 1670 | 1671 | UML_LOOK = NO 1672 | 1673 | # If the UML_LOOK tag is enabled, the fields and methods are shown inside 1674 | # the class node. If there are many fields or methods and many nodes the 1675 | # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1676 | # threshold limits the number of items for each type to make the size more 1677 | # managable. Set this to 0 for no limit. Note that the threshold may be 1678 | # exceeded by 50% before the limit is enforced. 1679 | 1680 | UML_LIMIT_NUM_FIELDS = 10 1681 | 1682 | # If set to YES, the inheritance and collaboration graphs will show the 1683 | # relations between templates and their instances. 1684 | 1685 | TEMPLATE_RELATIONS = NO 1686 | 1687 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1688 | # tags are set to YES then doxygen will generate a graph for each documented 1689 | # file showing the direct and indirect include dependencies of the file with 1690 | # other documented files. 1691 | 1692 | INCLUDE_GRAPH = YES 1693 | 1694 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1695 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1696 | # documented header file showing the documented files that directly or 1697 | # indirectly include this file. 1698 | 1699 | INCLUDED_BY_GRAPH = YES 1700 | 1701 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1702 | # doxygen will generate a call dependency graph for every global function 1703 | # or class method. Note that enabling this option will significantly increase 1704 | # the time of a run. So in most cases it will be better to enable call graphs 1705 | # for selected functions only using the \callgraph command. 1706 | 1707 | CALL_GRAPH = NO 1708 | 1709 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1710 | # doxygen will generate a caller dependency graph for every global function 1711 | # or class method. Note that enabling this option will significantly increase 1712 | # the time of a run. So in most cases it will be better to enable caller 1713 | # graphs for selected functions only using the \callergraph command. 1714 | 1715 | CALLER_GRAPH = NO 1716 | 1717 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1718 | # will generate a graphical hierarchy of all classes instead of a textual one. 1719 | 1720 | GRAPHICAL_HIERARCHY = YES 1721 | 1722 | # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1723 | # then doxygen will show the dependencies a directory has on other directories 1724 | # in a graphical way. The dependency relations are determined by the #include 1725 | # relations between the files in the directories. 1726 | 1727 | DIRECTORY_GRAPH = YES 1728 | 1729 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1730 | # generated by dot. Possible values are svg, png, jpg, or gif. 1731 | # If left blank png will be used. If you choose svg you need to set 1732 | # HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1733 | # visible in IE 9+ (other browsers do not have this requirement). 1734 | 1735 | DOT_IMAGE_FORMAT = png 1736 | 1737 | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1738 | # enable generation of interactive SVG images that allow zooming and panning. 1739 | # Note that this requires a modern browser other than Internet Explorer. 1740 | # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1741 | # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1742 | # visible. Older versions of IE do not have SVG support. 1743 | 1744 | INTERACTIVE_SVG = NO 1745 | 1746 | # The tag DOT_PATH can be used to specify the path where the dot tool can be 1747 | # found. If left blank, it is assumed the dot tool can be found in the path. 1748 | 1749 | DOT_PATH = 1750 | 1751 | # The DOTFILE_DIRS tag can be used to specify one or more directories that 1752 | # contain dot files that are included in the documentation (see the 1753 | # \dotfile command). 1754 | 1755 | DOTFILE_DIRS = 1756 | 1757 | # The MSCFILE_DIRS tag can be used to specify one or more directories that 1758 | # contain msc files that are included in the documentation (see the 1759 | # \mscfile command). 1760 | 1761 | MSCFILE_DIRS = 1762 | 1763 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1764 | # nodes that will be shown in the graph. If the number of nodes in a graph 1765 | # becomes larger than this value, doxygen will truncate the graph, which is 1766 | # visualized by representing a node as a red box. Note that doxygen if the 1767 | # number of direct children of the root node in a graph is already larger than 1768 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1769 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1770 | 1771 | DOT_GRAPH_MAX_NODES = 50 1772 | 1773 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1774 | # graphs generated by dot. A depth value of 3 means that only nodes reachable 1775 | # from the root by following a path via at most 3 edges will be shown. Nodes 1776 | # that lay further from the root node will be omitted. Note that setting this 1777 | # option to 1 or 2 may greatly reduce the computation time needed for large 1778 | # code bases. Also note that the size of a graph can be further restricted by 1779 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1780 | 1781 | MAX_DOT_GRAPH_DEPTH = 0 1782 | 1783 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1784 | # background. This is disabled by default, because dot on Windows does not 1785 | # seem to support this out of the box. Warning: Depending on the platform used, 1786 | # enabling this option may lead to badly anti-aliased labels on the edges of 1787 | # a graph (i.e. they become hard to read). 1788 | 1789 | DOT_TRANSPARENT = NO 1790 | 1791 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1792 | # files in one run (i.e. multiple -o and -T options on the command line). This 1793 | # makes dot run faster, but since only newer versions of dot (>1.8.10) 1794 | # support this, this feature is disabled by default. 1795 | 1796 | DOT_MULTI_TARGETS = NO 1797 | 1798 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1799 | # generate a legend page explaining the meaning of the various boxes and 1800 | # arrows in the dot generated graphs. 1801 | 1802 | GENERATE_LEGEND = YES 1803 | 1804 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1805 | # remove the intermediate dot files that are used to generate 1806 | # the various graphs. 1807 | 1808 | DOT_CLEANUP = YES -------------------------------------------------------------------------------- /scripts/osx/test: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | 4 | # find root path 5 | pushd `dirname $0`/../.. > /dev/null 6 | ROOT_DIR=`pwd` 7 | echo $ROOT_DIR 8 | popd > /dev/null 9 | 10 | 11 | BIN_DIR="$ROOT_DIR/bin/osx" 12 | INCLUDE_DIR="$ROOT_DIR/include" 13 | OBJ_DIR="$ROOT_DIR/obj/osx" 14 | SRC_DIR="$ROOT_DIR/src" 15 | 16 | 17 | # locate toolchain 18 | CC=`xcrun --find clang --sdk macosx 2>&1` 19 | OSXSDK=`xcrun --show-sdk-path --sdk macosx 2>&1` 20 | CFLAGS="-arch x86_64 -isysroot $OSXSDK -Wall -Werror" 21 | INCLUDES="-I$INCLUDE_DIR" 22 | 23 | 24 | # compile_c 25 | compile_c() { 26 | local src="$SRC_DIR/$1" 27 | local obj="$OBJ_DIR/$1.o" 28 | mkdir -p `dirname $obj` 29 | $CC $CFLAGS $INCLUDES -c $src -o $obj 30 | OBJS+=" $obj" 31 | } 32 | 33 | 34 | # link 35 | link() { 36 | local app=$1 37 | mkdir -p `dirname $app` 38 | $CC $CFLAGS $CXXFLAGS $FRAMEWORKS $OBJS -o $app 39 | } 40 | 41 | 42 | APP="$BIN_DIR/tests" 43 | 44 | 45 | compile_c "tests.c" && \ 46 | link $APP && \ 47 | echo "starting $APP...\n" && \ 48 | $APP; \ 49 | echo "finished $APP: $?" 50 | -------------------------------------------------------------------------------- /scripts/windows/test.bat: -------------------------------------------------------------------------------- 1 | @echo off 2 | setlocal 3 | 4 | 5 | set BIN_DIR=bin\windows 6 | set INCLUDE_DIR=include 7 | set OBJ_DIR=obj\windows 8 | set SRC_DIR=src 9 | 10 | 11 | :: locate toolchain 12 | call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" 13 | set OBJS= 14 | set LINK= 15 | 16 | 17 | goto:main 18 | 19 | 20 | :mkdir_for_file 21 | setlocal 22 | set dir=%~dp1 23 | if not exist "%dir%" mkdir "%dir%" 24 | endlocal 25 | exit /b 0 26 | 27 | 28 | :: compile_c 29 | :compile_c 30 | call:mkdir_for_file "%OBJ_DIR%\%1.obj" 31 | set OBJS=%OBJS% "%OBJ_DIR%\%1.obj" 32 | cl /nologo /I%INCLUDE_DIR% /c "%SRC_DIR%\%1" /Fo"%OBJ_DIR%\%1.obj" 33 | if %errorlevel% neq 0 goto:error 34 | exit /b %errorlevel% 35 | 36 | 37 | :: link 38 | :link 39 | call:mkdir_for_file "%1" 40 | echo.%1 41 | link /nologo /OUT:"%1" %OBJS% 42 | exit /b %errorlevel% 43 | 44 | 45 | :main 46 | 47 | 48 | set APP=%BIN_DIR%\main.exe 49 | call:compile_c tests.c 50 | call:link %APP% 51 | %APP% 52 | 53 | :error -------------------------------------------------------------------------------- /src/tests.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | 5 | #ifndef test 6 | void exit(int); 7 | static inline 8 | void test_failed(const char* file, const int line, const char* msg) { 9 | printf("%s:%i: %s\n", file, line, msg); 10 | exit(1); 11 | } 12 | #define test(expr) \ 13 | (((expr) ? 0 : test_failed(__FILE__, __LINE__, "test("#expr") failed"))) 14 | #endif 15 | 16 | 17 | static size_t destructed_element_count = 0; 18 | 19 | 20 | void destructed_element_count_destructor(int* begin, int* end) { 21 | for(; begin < end; ++begin) { 22 | destructed_element_count += 1; 23 | } 24 | } 25 | 26 | 27 | int main(int argc, const char* argv[]) { 28 | array_t(int) a = NULL; 29 | test(array_size(a) == 0); 30 | test(array_capacity(a) == 0); 31 | 32 | array_alloc(a, 0, destructed_element_count_destructor); 33 | test(array_size(a) == 0); 34 | test(array_capacity(a) == 0); 35 | 36 | 37 | array_append(a, 1); 38 | test(array_size(a) == 1); 39 | test(array_capacity(a) >= 1); 40 | test(a[0] == 1); 41 | 42 | 43 | array_append(a, 2); 44 | test(array_size(a) == 2); 45 | test(array_capacity(a) >= 2); 46 | test(a[0] == 1); 47 | test(a[1] == 2); 48 | 49 | 50 | array_append(a, 3); 51 | test(array_size(a) == 3); 52 | test(array_capacity(a) >= 3); 53 | test(a[0] == 1); 54 | test(a[1] == 2); 55 | test(a[2] == 3); 56 | 57 | 58 | array_insert(a, 0, 0); 59 | test(array_size(a) == 4); 60 | test(array_capacity(a) >= 4); 61 | test(a[0] == 0); 62 | test(a[1] == 1); 63 | test(a[2] == 2); 64 | test(a[3] == 3); 65 | 66 | 67 | array_reserve(a, 16); 68 | test(array_size(a) == 4); 69 | test(array_capacity(a) == 16); 70 | test(a[0] == 0); 71 | test(a[1] == 1); 72 | test(a[2] == 2); 73 | test(a[3] == 3); 74 | 75 | 76 | array_shrink(a); 77 | test(array_size(a) == 4); 78 | test(array_capacity(a) == 4); 79 | test(a[0] == 0); 80 | test(a[1] == 1); 81 | test(a[2] == 2); 82 | test(a[3] == 3); 83 | 84 | 85 | array_remove(a, 0); 86 | test(array_size(a) == 3); 87 | test(array_capacity(a) == 4); 88 | test(a[0] == 1); 89 | test(a[1] == 2); 90 | test(a[2] == 3); 91 | test(destructed_element_count == 1); 92 | destructed_element_count = 0; 93 | 94 | 95 | array_remove_unordered(a,0); 96 | test(array_size(a) == 2); 97 | test(array_capacity(a) == 4); 98 | test(a[0] == 3); 99 | test(a[1] == 2); 100 | test(destructed_element_count == 1); 101 | destructed_element_count = 0; 102 | 103 | 104 | array_clear(a); 105 | test(array_size(a) == 0); 106 | test(array_capacity(a) >= 0); 107 | test(destructed_element_count == 2); 108 | destructed_element_count = 0; 109 | 110 | 111 | array_append(a, 0); 112 | array_append(a, 1); 113 | array_append(a, 2); 114 | test(array_size(a) == 3); 115 | test(array_capacity(a) >= 3); 116 | test(destructed_element_count == 0); 117 | 118 | 119 | array_free(a); 120 | test(a == NULL); 121 | test(array_size(a) == 0); 122 | test(array_capacity(a) == 0); 123 | test(destructed_element_count == 3); 124 | destructed_element_count = 0; 125 | 126 | 127 | enum { TEST_LENGTH = 1024 }; 128 | 129 | 130 | array_alloc(a, 0, destructed_element_count_destructor); 131 | for (int i = 0; i < TEST_LENGTH; ++i) { 132 | array_append(a, i); 133 | test(a[i] == i); 134 | } 135 | test(array_size(a) == TEST_LENGTH); 136 | test(array_capacity(a) >= TEST_LENGTH); 137 | for (int i = 0; i < TEST_LENGTH; ++i) { 138 | test(a[i] == i); 139 | } 140 | { 141 | int i = 0; 142 | const int* const end = array_end(a); 143 | for (int* itr = array_begin(a); itr < end; ++itr) { 144 | test(*itr == i++); 145 | } 146 | } 147 | { 148 | int i = 0; 149 | while (array_size(a)) { 150 | test(a[0] == i++); 151 | array_remove(a,0); 152 | } 153 | test(array_size(a) == 0); 154 | test(array_capacity(a) >= TEST_LENGTH); 155 | test(destructed_element_count == TEST_LENGTH); 156 | destructed_element_count = 0; 157 | } 158 | array_free(a); 159 | test(a == NULL); 160 | test(array_size(a) == 0); 161 | test(array_capacity(a) == 0); 162 | 163 | 164 | array_alloc(a, 0, destructed_element_count_destructor); 165 | for (int i = 0; i < TEST_LENGTH; ++i) { 166 | array_insert(a, 0, i); 167 | } 168 | test(array_size(a) == TEST_LENGTH); 169 | test(array_capacity(a) >= TEST_LENGTH); 170 | for (int i = 0; i < TEST_LENGTH; ++i) { 171 | test(a[i] == (TEST_LENGTH - 1) - i); 172 | } 173 | array_free(a); 174 | test(a == NULL); 175 | test(array_size(a) == 0); 176 | test(array_capacity(a) == 0); 177 | 178 | 179 | puts("array tests passed"); 180 | } --------------------------------------------------------------------------------