xref: /isa-l/Doxyfile (revision 2bcbaf4c392426afd963545ac447c426b0cfa783)
1PROJECT_NAME           = "Intel Intelligent Storage Acceleration Library"
2PROJECT_BRIEF          = "ISA-L API reference doc"
3
4OUTPUT_DIRECTORY       = generated_doc
5FULL_PATH_NAMES        = NO
6TAB_SIZE               = 8
7ALIASES                = "requires=\xrefitem requires \"Requires\" \"Instruction Set Requirements for arch-specific functions (non-multibinary)\""
8OPTIMIZE_OUTPUT_FOR_C  = YES
9HIDE_UNDOC_MEMBERS     = YES
10USE_MDFILE_AS_MAINPAGE = README.md
11
12INPUT                  = isa-l.h \
13			 include \
14			 README.md \
15			 CONTRIBUTING.md \
16			 SECURITY.md \
17			 Release_notes.txt \
18			 doc/functions.md \
19			 doc/test.md \
20			 doc/build.md
21
22EXCLUDE                = include/test.h include/unaligned.h
23EXCLUDE_PATTERNS       = */include/*_multibinary.h
24EXAMPLE_PATH           = . crc raid erasure_code igzip
25PAPER_TYPE             = letter
26LATEX_SOURCE_CODE      = YES
27GENERATE_TREEVIEW      = YES
28MACRO_EXPANSION        = YES
29EXPAND_ONLY_PREDEF     = YES
30PREDEFINED             = "DECLARE_ALIGNED(n, a)=ALIGN n" \
31                         __declspec(x)='x' \
32                         align(x)='ALIGN \
33                         x'
34EXPAND_AS_DEFINED      = DECLARE_ALIGNED
35EXTENSION_MAPPING      = "txt=md"
36