xref: /isa-l_crypto/Doxyfile (revision faac8c3b0e226dcc0e598321b02f0cb9a920d722)
1PROJECT_NAME           = "Intel Intelligent Storage Acceleration Library Crypto"
2PROJECT_BRIEF          = "ISA-L_crypto 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_crypto.h \
13			 include \
14			 README.md \
15			 CONTRIBUTING.md \
16			 SECURITY.md \
17			 FIPS.md \
18			 Release_notes.txt
19
20EXCLUDE                = include/test.h include/memcpy_inline.h include/intrinreg.h include/endian_helper.h
21EXCLUDE_PATTERNS       = */include/*_multibinary.h */include/*_internal.h
22EXAMPLE_PATH           = . aes md5_mb mh_sha1 mh_sha1_murmur3_x64_128 mh_sha256 rolling_hash sha1_mb sha256_mb sha512_mb
23PAPER_TYPE             = letter
24LATEX_SOURCE_CODE      = YES
25GENERATE_TREEVIEW      = YES
26MACRO_EXPANSION        = YES
27EXPAND_ONLY_PREDEF     = YES
28PREDEFINED             = "DECLARE_ALIGNED(n, a)=ALIGN n" \
29                         __declspec(x)='x' \
30                         align(x)='ALIGN \
31                         x'
32EXPAND_AS_DEFINED      = DECLARE_ALIGNED
33EXTENSION_MAPPING      = "txt=md"
34