aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiels Ole Salscheider <niels_ole@salscheider-online.de>2017-09-04 11:40:23 +0200
committerNiels Ole Salscheider <niels_ole@salscheider-online.de>2017-09-04 20:16:31 +0200
commit2a42d04764c8539822b077d8261088bfcaec7fb7 (patch)
tree96517ace5840ca6ad4c110c2be5c497def8a62c8
parentcc9fa522269581764c9abd401973d4d1c84e0ca1 (diff)
downloadqxmpp-2a42d04764c8539822b077d8261088bfcaec7fb7.tar.gz
Port docs to new build system
-rw-r--r--CMakeLists.txt6
-rw-r--r--doc/CMakeLists.txt20
-rw-r--r--doc/Doxyfile.in13
-rw-r--r--doc/doc.pro24
-rw-r--r--doc/doxyfilter.cpp130
5 files changed, 38 insertions, 155 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index e838121e..23aad844 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -16,8 +16,8 @@ set(CMAKE_AUTORCC ON)
include(GNUInstallDirs)
option(BUILD_TESTS "Build tests." ON)
+option(BUILD_DOCUMENTATION "Build API documentation." OFF)
-#add_subdirectory(doc)
add_subdirectory(src)
#add_subdirectory(examples)
@@ -26,6 +26,10 @@ if(BUILD_TESTS)
add_subdirectory(tests)
endif()
+if(BUILD_DOCUMENTATION)
+ add_subdirectory(doc)
+endif()
+
install(
FILES QXmppConfig.cmake
DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/qxmpp"
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 00000000..fbffdcac
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1,20 @@
+find_package(Doxygen REQUIRED)
+
+set(DOXYGEN_INPUT
+ ${CMAKE_CURRENT_SOURCE_DIR}/index.doc
+ ${CMAKE_CURRENT_SOURCE_DIR}/using.doc
+ ${CMAKE_CURRENT_SOURCE_DIR}/xep.doc
+ ${CMAKE_SOURCE_DIR}/src
+)
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
+
+add_custom_target(
+ doc ALL
+ COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+ WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+ COMMENT "Generate API documentation with Doxygen"
+)
+
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION ${CMAKE_INSTALL_DOCDIR})
+
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
new file mode 100644
index 00000000..162406b5
--- /dev/null
+++ b/doc/Doxyfile.in
@@ -0,0 +1,13 @@
+PROJECT_NAME = "@CMAKE_PROJECT_NAME@"
+PROJECT_NUMBER = @VERSION_STRING@
+INPUT = @DOXYGEN_INPUT@
+
+ALPHABETICAL_INDEX = NO
+EXCLUDE_PATTERNS = */moc_* */mod_* */*_p.h */QXmppCodec.cpp */QXmppSasl.cpp
+FULL_PATH_NAMES = NO
+HIDE_UNDOC_CLASSES = YES
+GENERATE_LATEX = NO
+HTML_TIMESTAMP = NO
+QUIET = YES
+RECURSIVE = YES
+
diff --git a/doc/doc.pro b/doc/doc.pro
deleted file mode 100644
index 3a3a46ce..00000000
--- a/doc/doc.pro
+++ /dev/null
@@ -1,24 +0,0 @@
-include(../qxmpp.pri)
-
-TEMPLATE = app
-CONFIG += console
-CONFIG -= app_bundle
-QT -= gui
-
-INCLUDEPATH += $$QXMPP_INCLUDEPATH
-TARGET = doxyfilter
-SOURCES += doxyfilter.cpp
-
-windows {
- DOXYFILTER = $${TARGET}.exe
-} else {
- DOXYFILTER = ./$${TARGET}
-}
-
-# Build rules
-docs.commands = $${DOXYFILTER} -g $${PWD} && $${DOXYFILTER}
-docs.depends = $${TARGET}
-
-QMAKE_CLEAN += Doxyfile doxygen_sqlite3.db
-unix:QMAKE_DISTCLEAN += -r html
-QMAKE_EXTRA_TARGETS += docs
diff --git a/doc/doxyfilter.cpp b/doc/doxyfilter.cpp
deleted file mode 100644
index e54fceb6..00000000
--- a/doc/doxyfilter.cpp
+++ /dev/null
@@ -1,130 +0,0 @@
-/*
- * Copyright (C) 2008-2014 The QXmpp developers
- *
- * Author:
- * Jeremy Lainé
- *
- * Source:
- * https://github.com/qxmpp-project/qxmpp
- *
- * This file is a part of QXmpp library.
- *
- * This library 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.
- *
- * This library 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.
- *
- */
-
-#include <cstdlib>
-#include <iostream>
-
-#include <QCoreApplication>
-#include <QFile>
-#include <QProcess>
-#include <QRegExp>
-#include <QTextStream>
-
-#include "QXmppGlobal.h"
-
-static void setField(QString &code, const QString &name, const QString &value)
-{
- code.replace(
- QRegExp(QString("(%1\\s*=)[^\\r\\n]*").arg(name)),
- QString("\\1 %1").arg(value));
-}
-
-static void usage() {
- QTextStream output(stderr);
- output << "Usage:" << endl;
- output << " doxyfilter Generate documentation" << endl;
- output << " doxyfilter -g Generate Doxyfile" << endl;
- output << " doxyfilter <sourcefile> Filter the given file's code" << endl;
-}
-
-int main(int argc, char *argv[])
-{
- QCoreApplication app(argc, argv);
-
- if (argc == 1)
- return QProcess::execute("doxygen");
- else if (argc < 2) {
- usage();
- return 1;
- }
-
- if (!strcmp(argv[1], "-g")) {
- // generate default Doxyfile
- QProcess process;
- process.start("doxygen", QStringList() << "-g" << "-");
- if (!process.waitForFinished()) {
- qWarning("Could not run doxygen");
- return 1;
- }
- QString code = QString::fromUtf8(process.readAll());
-
- QString docDir = (argc > 2) ? (QString::fromLocal8Bit(argv[2]) + "/") : "";
- QStringList docFiles = QStringList() << "index.doc" << "using.doc" << "xep.doc" << "../src";
- for (int i = 0; i < docFiles.size(); ++i) {
- docFiles[i] = docDir + docFiles[i];
- }
-
- // adjust Doxyfile
- setField(code, "ALPHABETICAL_INDEX", "NO");
- setField(code, "EXCLUDE_PATTERNS", "*/moc_* */mod_* */qdnslookup* */*_p.h */QXmppCodec.cpp */QXmppSasl.cpp");
- setField(code, "FULL_PATH_NAMES", "NO");
- setField(code, "HIDE_UNDOC_CLASSES", "YES");
- setField(code, "GENERATE_LATEX", "NO");
- setField(code, "HTML_TIMESTAMP", "NO");
- setField(code, "INPUT", docFiles.join(" "));
- setField(code, "INPUT_FILTER", QString::fromLocal8Bit(argv[0]));
- setField(code, "PROJECT_NAME", "QXmpp");
- setField(code, "PROJECT_NUMBER", QString("Version: %1.%2.%3").arg(
- QString::number((QXMPP_VERSION >> 16) & 0xff),
- QString::number((QXMPP_VERSION >> 8) & 0xff),
- QString::number(QXMPP_VERSION & 0xff)));
- setField(code, "QUIET", "YES");
- setField(code, "RECURSIVE", "YES");
-
- // write doxyfile
- QFile output("Doxyfile");
- if (!output.open(QIODevice::WriteOnly)) {
- qWarning("Could not write to %s", qPrintable(output.fileName()));
- return 1;
- }
- output.write(code.toUtf8());
- output.close();
-
- } else if (!strcmp(argv[1], "-h")) {
- usage();
- return 0;
- } else {
- // read source code
- QFile source(QString::fromLocal8Bit(argv[1]));
- if (!source.open(QIODevice::ReadOnly)) {
- qWarning("Could not open %s", qPrintable(source.fileName()));
- return 1;
- }
- QString code = QString::fromUtf8(source.readAll());
- source.close();
-
- // add links for RFCs
- QRegExp rfcRegexp("(RFC ([0-9]{4})(: [^\\s.]+( [A-Z][^\\s.]*)*)?)");
- code.replace(rfcRegexp, "<a href=\"http://www.rfc-editor.org/rfc/rfc\\2.txt\">\\1</a>");
-
- // add links for XEPs
- QRegExp regexp("(XEP-([0-9]{4})(: [^\\s.]+( [A-Z][^\\s.]*)*)?)");
- code.replace(regexp, "<a href=\"http://xmpp.org/extensions/xep-\\2.html\">\\1</a>");
-
- QTextStream output(stdout);
- output << code;
- }
-
- return 0;
-}
-