summaryrefslogtreecommitdiffstats
path: root/src/isa-l/Doxyfile
diff options
context:
space:
mode:
Diffstat (limited to 'src/isa-l/Doxyfile')
-rw-r--r--src/isa-l/Doxyfile31
1 files changed, 31 insertions, 0 deletions
diff --git a/src/isa-l/Doxyfile b/src/isa-l/Doxyfile
new file mode 100644
index 000000000..cb0673730
--- /dev/null
+++ b/src/isa-l/Doxyfile
@@ -0,0 +1,31 @@
+PROJECT_NAME = "Intel Intelligent Storage Acceleration Library"
+PROJECT_BRIEF = "ISA-L API reference doc"
+
+OUTPUT_DIRECTORY = generated_doc
+FULL_PATH_NAMES = NO
+TAB_SIZE = 8
+ALIASES = "requires=\xrefitem requires \"Requires\" \"Instruction Set Requirements for arch-specific functions (non-multibinary)\""
+OPTIMIZE_OUTPUT_FOR_C = YES
+HIDE_UNDOC_MEMBERS = YES
+USE_MDFILE_AS_MAINPAGE = README.md
+
+INPUT = isa-l.h \
+ include \
+ README.md \
+ CONTRIBUTING.md \
+ Release_notes.txt
+
+EXCLUDE = include/test.h include/types.h include/unaligned.h
+EXCLUDE_PATTERNS = */include/*_multibinary.h
+EXAMPLE_PATH = . crc raid erasure_code igzip
+PAPER_TYPE = letter
+LATEX_SOURCE_CODE = YES
+GENERATE_TREEVIEW = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = YES
+PREDEFINED = "DECLARE_ALIGNED(n, a)=ALIGN n" \
+ __declspec(x)='x' \
+ align(x)='ALIGN \
+ x'
+EXPAND_AS_DEFINED = DECLARE_ALIGNED
+EXTENSION_MAPPING = "txt=md"