GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Qt: Add doc generation with doxygen

Browse Source 
* configure.ac: Look for doxygen if qt is built.
 Configure new files.
* lang/qt/doc/Doxyfile.in: New.
* lang/qt/doc/Makefile.am: New.
* lang/qt/README: Update.

--
Currently this is a standard doxyfile template without much
customization.
This commit is contained in:
Andre Heinecke 2016-04-11 18:10:54 +02:00
parent d9f7a18ed8
commit a1e95f36ce
5 changed files with 2396 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
configure.ac
View File

@ -286,6 +286,14 @@ if test "$found" = "1"; then
*** Qt5 (Qt5Core) is required for qt binding.
***]])
fi
AC_CHECK_PROGS([DOXYGEN], [doxygen])
if test -z "$DOXYGEN";
then AC_MSG_WARN([Doxygen not found - Qt binding doc will not be built.])
fi
AM_CONDITIONAL([HAVE_DOXYGEN],
[test -n "$DOXYGEN"])
# Make sure that qt comes after cpp
enabled_languages=`echo $enabled_languages | sed 's/qt//'`
enabled_languages=`echo $enabled_languages qt`
@ -686,6 +694,8 @@ AC_CONFIG_FILES(lang/qt/src/QGpgmeConfig.cmake.in)
AC_CONFIG_FILES(lang/qt/src/QGpgmeConfigVersion.cmake)
AC_CONFIG_FILES(lang/qt/tests/Makefile)
AC_CONFIG_FILES([lang/Makefile lang/cl/Makefile lang/cl/gpgme.asd])
AM_COND_IF([HAVE_DOXYGEN], [AC_CONFIG_FILES([lang/qt/doc/Doxyfile])])
AC_CONFIG_FILES(lang/qt/doc/Makefile)
AC_OUTPUT
echo "

2
lang/qt/Makefile.am
View File

@ -18,6 +18,6 @@
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA
SUBDIRS = src tests
SUBDIRS = src tests doc
EXTRA_DIST = README

7
lang/qt/README
View File

@ -1,6 +1,6 @@
Qt API bindings/wrapper for gpgme
----------------------------------------
Based on KF5gpgmepp QGpgme
Based on KF5gpgmepp QGpgme and libkleo/backends/qgpgme
QGpgme is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
@ -21,7 +21,4 @@ Overview
--------
QGpgme provides Qt API bindings around Gpgmepp. It depends on Gpgmepp.
Currently this is a very thin library that only provides a QByteArray
and QIODevice dataprovider. But might be extended in the future with
code that is currently part of KDE's libkleopatra. To provide an easy
to use API for Qt Applications.
See the generated documentation for more info

2352
lang/qt/doc/Doxyfile.in Normal file
View File

File diff suppressed because it is too large Load Diff

31
lang/qt/doc/Makefile.am Normal file
View File

@ -0,0 +1,31 @@
# Makefile.am - Makefile for GPGME Qt docs.
# Copyright (C) 2016 Intevation GmbH
#
# This file is part of GPGME.
#
# GPGME is free software; you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation; either version 2.1 of the
# License, or (at your option) any later version.
#
# GPGME is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
# Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program; if not, see <http://www.gnu.org/licenses/>.
## Process this file with automake to produce Makefile.in
if HAVE_DOXYGEN
doxyfile.stamp:
$(DOXYGEN) Doxyfile
touch doxyfile.stamp
CLEANFILES = doxyfile.stamp
all-local: doxyfile.stamp
clean-local:
rm -rf $(abs_builddir)/generated
endif