diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..1678ca7 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,27 @@ +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 + +INPUT = isa-l.h \ + include \ + README.md \ + Release_notes.txt + +EXCLUDE = include/test.h +EXAMPLE_PATH = . crc raid erasure_code igzip +PAPER_TYPE = letter +LATEX_SOURCE_CODE = 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" diff --git a/Makefile.am b/Makefile.am index aa5dfa4..8b9c6a1 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,4 @@ -EXTRA_DIST = autogen.sh Makefile.unx make.inc Makefile.nmake isa-l.def LICENSE README.md +EXTRA_DIST = autogen.sh Makefile.unx make.inc Makefile.nmake isa-l.def LICENSE README.md Doxyfile CLEANFILES = LDADD = AM_MAKEFLAGS = --no-print-directory @@ -106,9 +106,7 @@ isa-l.h: @for unit in $(sort $(extern_hdrs)); do echo "#include " | sed -e 's;include/;;' >> $@; done @echo '#endif //_ISAL_H_' >> $@ - -license = bsd -licc = $(srcdir)/doc/license_$(license)_c.txt -lica = $(srcdir)/doc/license_$(license)_asm.txt -licm = $(srcdir)/doc/license_$(license)_make.txt - +doc: isa-l.h + (cat Doxyfile; echo 'PROJECT_NUMBER=${VERSION}') | doxygen - + $(MAKE) -C generated_doc/latex &> generated_doc/latex_build_api.log + cp generated_doc/latex/refman.pdf isa-l_api_${VERSION}.pdf diff --git a/make.inc b/make.inc index ff4f43c..d1689cd 100644 --- a/make.inc +++ b/make.inc @@ -271,4 +271,8 @@ clean: @$(RM) -r $(O) *.o *.a $(all_tests) $(lib_name) $(so_lib_name) +doc: isa-l.h + (cat Doxyfile; echo 'PROJECT_NUMBER=$(version)') | doxygen - + $(MAKE) -C generated_doc/latex &> generated_doc/latex_build_api.log + cp generated_doc/latex/refman.pdf isa-l_api_$(version).pdf