Add docs folder for basic documentation configuration

This commit is contained in:
Simon Stürz 2019-10-01 16:18:35 +02:00
parent 80452061e3
commit 2b823b2a41
3 changed files with 57 additions and 0 deletions

31
docs/config.qdocconf Normal file
View File

@ -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

View File

@ -0,0 +1,12 @@
HTML.templatedir = .
HTML.postpostheader = \
"<div class=\"content mainContent\">\n"
HTML.prologue = \
"<div class=\"context\">\n"
HTML.footer = \
"</div>\n" \
"</div>\n"

14
docs/index.qdoc Normal file
View File

@ -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
*/