Merge pull request #66 from kronosnet/doxyfication

Doxyfication

.gitignore

@@ -48,3 +48,6 @@ kronosnet.spec
 test-driver
 *.trs
 *.log
+Doxyfile
+doxyfile.stamp
+xml/

configure.ac

@@ -65,6 +65,16 @@ AC_PROG_INSTALL
 AC_PROG_MAKE_SET
 PKG_PROG_PKG_CONFIG
 AC_CHECK_PROGS([PUBLICAN], [publican], [:])
+AC_CHECK_PROGS([DOXYGEN], [doxygen])
+AC_CHECK_PROGS([DOXY2MAN], [doxy2man])
+
+manpageupdates=1
+if test "x$DOXYGEN" = "x" || test "x$DOXY2MAN" = "x"; then
+	manpageupdates=0;
+fi
+
+AM_CONDITIONAL([MANPAGEUPDATES], [test $manpageupdates -gt 0])
+
 AC_CHECK_PROGS([VALGRIND_EXEC], [valgrind])
 AM_CONDITIONAL([HAS_VALGRIND], [test x$VALGRIND_EXEC != "x"])
 
@@ -493,6 +503,8 @@ AC_CONFIG_FILES([
 		libknet/Makefile
 		libknet/libknet.pc
 		libknet/tests/Makefile
+		libknet/man/Doxyfile
+		libknet/man/Makefile
 		docs/Makefile
 		poc-code/Makefile
 		poc-code/iov-hash/Makefile

kronosnet.spec.in

@@ -355,6 +355,7 @@ Requires: pkgconfig
 %{_libdir}/libknet.so
 %{_includedir}/libknet.h
 %{_libdir}/pkgconfig/libknet.pc
+%{_mandir}/man3/*.3.gz
 
 %changelog
 * @date@ Autotools generated version <nobody@nowhere.org> - @version@-1-@numcomm@.@alphatag@.@dirty@

libknet/Makefile.am

@@ -15,7 +15,7 @@ SYMFILE			= libknet_exported_syms
 
 EXTRA_DIST		= $(SYMFILE)
 
-SUBDIRS			= . tests
+SUBDIRS			= . tests man
 
 libversion		= 1:0:0
 
@@ -96,3 +96,19 @@ libknet_la_LDFLAGS	= -Wl,--version-script=$(srcdir)/$(SYMFILE) \
 			  -version-number $(libversion)
 
 libknet_la_LIBADD	= $(dl_LIBS) $(pthread_LIBS) $(rt_LIBS) $(m_LIBS)
+
+dist_man_MANS		= man
+
+update-man-pages: doxyfile.stamp
+
+doxyfile.stamp: Doxyfile
+if MANPAGEUPDATES
+	$(DOXYGEN) Doxyfile
+	$(DOXY2MAN) -o $(abs_srcdir)/man -s 3 --short-pkg @PACKAGE_NAME@ --pkg "Kronosnet Programmer's Manual" $(builddir)/xml/libknet_8h.xml
+else
+	@echo this system does not have doxy2man or doxygen installed. Unable to update man pages automatically.
+endif
+	touch doxyfile.stamp
+
+clean-local:
+	rm -rf doxyfile.stamp xml