changeset 25:2549facbedfb

add doxygen API
author David Demelier <markand@malikania.fr>
date Sun, 01 Sep 2019 17:53:01 +0200
parents f92079906943
children 89a5b4240372
files Makefile index.md
diffstat 2 files changed, 27 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/Makefile	Sun Sep 01 17:31:25 2019 +0200
+++ b/Makefile	Sun Sep 01 17:53:01 2019 +0200
@@ -24,7 +24,7 @@
 MANDOC_PDF=     -T pdf
 MANDOC_HTML=    -T html -O man=%N.html
 RM=             rm -f
-VERSION=        3.0.0
+VERSION=        3.0.1
 SOURCE=         irccd-${VERSION}.tar.xz
 MANSRCS=        irccd-api.7 \
                 irccd-ipc.7 \
@@ -47,7 +47,7 @@
 
 .SUFFIXES: .html .md
 
-all: site man
+all: site man doxygen
 
 ${FILES}: templates/template.html
 
@@ -57,6 +57,7 @@
 site: ${FILES}
 
 man: ${SOURCE}
+	@rm -rf irccd-${VERSION}
 	@tar xf ${SOURCE}
 .for m in ${MANSRCS}
 	@echo GEN ${m:C/[0-9]$/pdf/:_}
@@ -77,10 +78,20 @@
 	@rm -rf irccd-${VERSION}
 
 clean:
-	@${RM} ${SOURCE} *.html *.pdf
+	@${RM} ${SOURCE} *.html *.pdf api
+
+doxygen: ${SOURCE}
+	@echo GEN doxygen
+	@rm -rf irccd-${VERSION}
+	@tar xf ${SOURCE}
+	@mkdir -p irccd-${VERSION}/build
+	@cmake -S irccd-${VERSION} -B irccd-${VERSION}/build > /dev/null 2>&1
+	@cmake --build irccd-${VERSION}/build --target doxygen > /dev/null
+	@rsync -a --delete irccd-${VERSION}/build/doc/doxygen/html/ api
+	@rm -rf irccd-${VERSION}
 
 publish: site man
-	@rsync -av css webfonts *.html *.pdf ${DESTINATION}
+	@rsync -av css webfonts *.html *.pdf api ${DESTINATION}
 
 .md.html:
 	@echo GEN $@
--- a/index.md	Sun Sep 01 17:31:25 2019 +0200
+++ b/index.md	Sun Sep 01 17:53:01 2019 +0200
@@ -17,7 +17,9 @@
 News
 ----
 
-- (2019-08-16) New release: irccd 3.0.0
+- (2019-09-01) New release: irccd 3.0.1,
+- (2019-09-01) C++ doxygen documentation is online.
+- (2019-08-16) New release: irccd 3.0.0.
 
 Downloads
 ---------
@@ -25,10 +27,10 @@
 Irccd is only distributed as source package on the official website but some
 distributions may provide binary packages.
 
-Current version is 3.0.0
+Current version is 3.0.1
 
-- [irccd-3.0.0.tar.xz][] ([signature][irccd-3.0.0.tar.xz.asc])
-- [irccd-3.0.0.zip][] ([signature][irccd-3.0.0.zip.asc])
+- [irccd-3.0.1.tar.xz][] ([signature][irccd-3.0.1.tar.xz.asc])
+- [irccd-3.0.1.zip][] ([signature][irccd-3.0.1.zip.asc])
 
 For those who wants to use the development version, it is available in the
 Mercurial [repository](http://hg.malikania.fr/irccd):
@@ -70,6 +72,8 @@
 
 - [versioning](versioning.html): an information page about semantic versioning
   rules applied in irccd.
+- [C++ API](api/index.html): the C++ API for native plugins and hacking on irccd
+  itself.
 
 Help
 ----
@@ -99,10 +103,10 @@
 - [RFC2810](https://tools.ietf.org/html/rfc2810)
 - [RFC2813](https://tools.ietf.org/html/rfc2813)
 
-[irccd-3.0.0.tar.xz.asc]: http://releases.malikania.fr/irccd/3.0.0/irccd-3.0.0.tar.xz.asc
-[irccd-3.0.0.tar.xz]: http://releases.malikania.fr/irccd/3.0.0/irccd-3.0.0.tar.xz
-[irccd-3.0.0.zip.asc]: http://releases.malikania.fr/irccd/3.0.0/irccd-3.0.0.zip.asc
-[irccd-3.0.0.zip]: http://releases.malikania.fr/irccd/3.0.0/irccd-3.0.0.zip
+[irccd-3.0.1.tar.xz.asc]: http://releases.malikania.fr/irccd/3.0.1/irccd-3.0.1.tar.xz.asc
+[irccd-3.0.1.tar.xz]: http://releases.malikania.fr/irccd/3.0.1/irccd-3.0.1.tar.xz
+[irccd-3.0.1.zip.asc]: http://releases.malikania.fr/irccd/3.0.1/irccd-3.0.1.zip.asc
+[irccd-3.0.1.zip]: http://releases.malikania.fr/irccd/3.0.1/irccd-3.0.1.zip
 [irccd-api.7.pdf]: irccd-api.pdf
 [irccd-api.7]: irccd-api.html
 [irccd-plugin-ask.7.pdf]: irccd-plugin-ask.pdf