xref: /isa-l/Doxyfile (revision 2bcbaf4c392426afd963545ac447c426b0cfa783)
19be74b38SGreg TuckerPROJECT_NAME           = "Intel Intelligent Storage Acceleration Library"
29be74b38SGreg TuckerPROJECT_BRIEF          = "ISA-L API reference doc"
39be74b38SGreg Tucker
49be74b38SGreg TuckerOUTPUT_DIRECTORY       = generated_doc
59be74b38SGreg TuckerFULL_PATH_NAMES        = NO
69be74b38SGreg TuckerTAB_SIZE               = 8
79be74b38SGreg TuckerALIASES                = "requires=\xrefitem requires \"Requires\" \"Instruction Set Requirements for arch-specific functions (non-multibinary)\""
89be74b38SGreg TuckerOPTIMIZE_OUTPUT_FOR_C  = YES
99be74b38SGreg TuckerHIDE_UNDOC_MEMBERS     = YES
10b0ffac51SGreg TuckerUSE_MDFILE_AS_MAINPAGE = README.md
119be74b38SGreg Tucker
129be74b38SGreg TuckerINPUT                  = isa-l.h \
139be74b38SGreg Tucker			 include \
149be74b38SGreg Tucker			 README.md \
15b0ffac51SGreg Tucker			 CONTRIBUTING.md \
16*2bcbaf4cSGreg Tucker			 SECURITY.md \
17ece814e9SGreg Tucker			 Release_notes.txt \
18ad8dce15SGreg Tucker			 doc/functions.md \
19ece814e9SGreg Tucker			 doc/test.md \
20ece814e9SGreg Tucker			 doc/build.md
219be74b38SGreg Tucker
22112dd72cSGreg TuckerEXCLUDE                = include/test.h include/unaligned.h
2366cff999SGreg TuckerEXCLUDE_PATTERNS       = */include/*_multibinary.h
249be74b38SGreg TuckerEXAMPLE_PATH           = . crc raid erasure_code igzip
259be74b38SGreg TuckerPAPER_TYPE             = letter
269be74b38SGreg TuckerLATEX_SOURCE_CODE      = YES
2766cff999SGreg TuckerGENERATE_TREEVIEW      = YES
289be74b38SGreg TuckerMACRO_EXPANSION        = YES
299be74b38SGreg TuckerEXPAND_ONLY_PREDEF     = YES
309be74b38SGreg TuckerPREDEFINED             = "DECLARE_ALIGNED(n, a)=ALIGN n" \
319be74b38SGreg Tucker                         __declspec(x)='x' \
329be74b38SGreg Tucker                         align(x)='ALIGN \
339be74b38SGreg Tucker                         x'
349be74b38SGreg TuckerEXPAND_AS_DEFINED      = DECLARE_ALIGNED
359be74b38SGreg TuckerEXTENSION_MAPPING      = "txt=md"
36