mdbx: initial support for doxygen.

Change-Id: I5258b9f5dac981f03658ed35a799a52250a3e136

ChangeLog.md

@@ -1,8 +1,12 @@
+ChangeLog
+---------
+
 ## v0.9.x (in the development):
 - Since v0.9 usage of custom comparators and the `mdbx_dbi_open_ex()` are deprecated.
 - TODO: API for explicit threads (de)registration.
 - TODO: Native bindings for C++.
 - TODO: Packages for AltLinux, Fedora/RHEL, Debian/Ubuntu.
+- TODO: support for Doxygen & online API reference.
 
 ## v0.8.2 2020-07-06:
 - Added support multi-opening the same DB in a process with SysV locking (BSD).

GNUmakefile

@@ -48,7 +48,7 @@ LIBRARIES  := libmdbx.a libmdbx.$(SO_SUFFIX)
 TOOLS      := mdbx_stat mdbx_copy mdbx_dump mdbx_load mdbx_chk
 MANPAGES   := mdbx_stat.1 mdbx_copy.1 mdbx_dump.1 mdbx_load.1 mdbx_chk.1
 
-.PHONY: mdbx all install clean test dist check
+.PHONY: mdbx all install clean
 
 all: $(LIBRARIES) $(TOOLS)
 
@@ -99,6 +99,8 @@ else
 ################################################################################
 # Plain (non-amalgamated) sources with test
 
+.PHONY: test dist check doxygen reformat
+
 define uname2osal
   case "$(UNAME)" in
     CYGWIN*|MINGW*|MSYS*|Windows*) echo windows;;
@@ -240,6 +242,21 @@ mdbx-dylib.o: src/config.h src/version.c src/alloy.c $(ALLOY_DEPS) $(lastword $(
 mdbx-static.o: src/config.h src/version.c src/alloy.c $(ALLOY_DEPS) $(lastword $(MAKEFILE_LIST))
 	$(CC) $(CFLAGS) $(MDBX_OPTIONS) '-DMDBX_CONFIG_H="config.h"' -ULIBMDBX_EXPORTS -c src/alloy.c -o $@
 
+docs/Doxyfile: docs/Doxyfile.in src/version.c
+	sed \
+		-e "s|@MDBX_GIT_TIMESTAMP@|$(MDBX_GIT_TIMESTAMP)|" \
+		-e "s|@MDBX_GIT_TREE@|$(shell git show --no-patch --format=%T HEAD || echo 'Please install latest get version')|" \
+		-e "s|@MDBX_GIT_COMMIT@|$(shell git show --no-patch --format=%H HEAD || echo 'Please install latest get version')|" \
+		-e "s|@MDBX_GIT_DESCRIBE@|$(MDBX_GIT_DESCRIBE)|" \
+		-e "s|\$${MDBX_VERSION_MAJOR}|$(shell echo '$(MDBX_GIT_VERSION)' | cut -d . -f 1)|" \
+		-e "s|\$${MDBX_VERSION_MINOR}|$(shell echo '$(MDBX_GIT_VERSION)' | cut -d . -f 2)|" \
+		-e "s|\$${MDBX_VERSION_RELEASE}|$(shell echo '$(MDBX_GIT_VERSION)' | cut -d . -f 3)|" \
+		-e "s|\$${MDBX_VERSION_REVISION}|$(MDBX_GIT_REVISION)|" \
+	docs/Doxyfile.in > $@
+
+doxygen: docs/Doxyfile mdbx.h LICENSE AUTHORS
+	rm -rf docs/html && mkdir -p docs/html && cp LICENSE AUTHORS docs/html/ && doxygen docs/Doxyfile
+
 .PHONY: dist release-assets
 dist: libmdbx-sources-$(MDBX_VERSION_SUFFIX).tar.gz $(lastword $(MAKEFILE_LIST))
 

Makefile

@@ -1,4 +1,4 @@
-all bench bench-quartet build-test check clean clean-bench cross-gcc cross-qemu dist gcc-analyzer install mdbx memcheck reformat release-assets strip test test-asan test-fault test-leak test-singleprocess test-ubsan test-valgrind tools:
+all bench bench-quartet build-test check clean clean-bench cross-gcc cross-qemu dist doxygen gcc-analyzer install mdbx memcheck reformat release-assets strip test test-asan test-fault test-leak test-singleprocess test-ubsan test-valgrind tools:
 	@CC=$(CC) \
 	CXX=`if test -n "$(CXX)" && which "$(CXX)" > /dev/null; then echo "$(CXX)"; elif test -n "$(CCC)" && which "$(CCC)" > /dev/null; then echo "$(CCC)"; else echo "c++"; fi` \
 	`which gmake || which gnumake || echo 'echo "GNU Make is required"; exit 2;'` \