Add index documentation page

docs/config.qdocconf

@@ -22,9 +22,9 @@ sourceencoding          = UTF-8
 syntaxhighlighting = true
 
 headerdirs = ../libnymea-gpio
-sourcedirs = ../libnymea-gpio
+sourcedirs = ../libnymea-gpio ../docs
 
 headers.fileextensions = "*.h"
-sources.fileextensions = "*.cpp"
+sources.fileextensions = "*.cpp *.qdoc"
 
 Cpp.ignoredirectives = Q_DECLARE_METATYPE Q_DECLARE_LOGGING_CATEGORY Q_LOGGING_CATEGORY Q_ENUM

docs/index.qdoc

@@ -0,0 +1,11 @@
+/*!
+    \page index.html
+    \title nymea-gpio documentation
+
+    The nymea-gpio library allowes to interact in an confortable way with system GPIOs. 
+
+    \chapter Classes
+    \annotatedlist gpio
+
+*/
+

libnymea-gpio/gpio.cpp

@@ -24,6 +24,7 @@
     \class Gpio
     \brief Represents a system GPIO in linux systems.
     \inmodule nymea-gpio
+    \ingroup gpio
 
     A "General Purpose Input/Output" (GPIO) is a flexible software-controlled
     digital signal. They are provided from many kinds of chip, and are familiar

libnymea-gpio/gpiobutton.cpp

@@ -24,6 +24,7 @@
     \class GpioButton
     \brief Represents a GPIO Button with some helper methods.
     \inmodule nymea-gpio
+    \ingroup gpio
 
     This class represents a Button based on a GPIO. The class takes care about the \l{clicked()} signal handling, debounces the GPIO signal
     and offers a nice interface for \l{longPressed()} behaviour.

libnymea-gpio/gpiobutton.h

@@ -33,7 +33,7 @@ class GpioButton : public QObject
 {
     Q_OBJECT
 public:
-    explicit GpioButton(int gpioNumber, QObject *parent = nullptr);
+    explicit GpioButton(int gpio, QObject *parent = nullptr);
 
     int gpioNumber() const;
 

libnymea-gpio/gpiomonitor.cpp

@@ -24,6 +24,7 @@
     \class GpioMonitor
     \brief Monitor for GPIO interrupts.
     \inmodule nymea-gpio
+    \ingroup gpio
 
     This class allows to monitor an input GPIO for the interrupts depending on the edge interrupt configuration.