mirror of
https://github.com/intel/isa-l.git
synced 2025-01-19 04:26:08 +01:00
doc: Add doxyfile for API doc creation
Signed-off-by: Greg Tucker <greg.b.tucker@intel.com>
This commit is contained in:
parent
d549db38e5
commit
9be74b389f
27
Doxyfile
Normal file
27
Doxyfile
Normal file
@ -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"
|
12
Makefile.am
12
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 <isa-l/$$unit>" | 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
|
||||
|
4
make.inc
4
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
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user