From 2b823b2a41dc936e128d968ffb51e7ab40de638a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Tue, 1 Oct 2019 16:18:35 +0200 Subject: [PATCH] Add docs folder for basic documentation configuration --- docs/config.qdocconf | 31 +++++++++++++++++++++++++++++++ docs/html-template.qdocconf | 12 ++++++++++++ docs/index.qdoc | 14 ++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 docs/config.qdocconf create mode 100644 docs/html-template.qdocconf create mode 100644 docs/index.qdoc diff --git a/docs/config.qdocconf b/docs/config.qdocconf new file mode 100644 index 0000000..3908b4a --- /dev/null +++ b/docs/config.qdocconf @@ -0,0 +1,31 @@ +include(html-template.qdocconf) + +project = libnymea-networkmanager +description = libnymea-networkmanager documentation + +dita.metadata.default.author = Simon Stürz +dita.metadata.default.permissions = all +dita.metadata.default.publisher = guh GmbH +dita.metadata.default.copyryear = 2019 +dita.metadata.default.copyrholder = Simon Stürz +dita.metadata.default.audience = programmer + +outputdir = html +outputformats = HTML + +language = Cpp + +naturallanguage = en_US +outputencoding = UTF-8 +sourceencoding = UTF-8 + +syntaxhighlighting = true + +headerdirs = ../libnymea-networkmanager +sourcedirs = ../libnymea-networkmanager ../docs + +headers.fileextensions = "*.h" +sources.fileextensions = "*.cpp *.qdoc" + +Cpp.ignoredirectives = Q_DECLARE_METATYPE Q_DECLARE_LOGGING_CATEGORY Q_LOGGING_CATEGORY Q_ENUM + diff --git a/docs/html-template.qdocconf b/docs/html-template.qdocconf new file mode 100644 index 0000000..e306a0f --- /dev/null +++ b/docs/html-template.qdocconf @@ -0,0 +1,12 @@ +HTML.templatedir = . + +HTML.postpostheader = \ + "
\n" + +HTML.prologue = \ + "
\n" + +HTML.footer = \ + "
\n" \ + "
\n" + diff --git a/docs/index.qdoc b/docs/index.qdoc new file mode 100644 index 0000000..c9628b4 --- /dev/null +++ b/docs/index.qdoc @@ -0,0 +1,14 @@ +/*! + \page index.html + \title libnymea-networkmanager documentation + + The libnymea-networkmanager library allowes to interact with the network-manager DBus API and optional start also a Bluetooth LE server for remote network set up. + + \chapter Classes network-manager + \annotatedlist networkmanager + + \chapter Classes network-manager bluetooth + \annotatedlist networkmanager-bluetooth + +*/ +