Commit 10597d65 authored by Valeriy Malov's avatar Valeriy Malov
Browse files

Update/add a few doxygen descriptions

parent 75cb33dd
......@@ -67,7 +67,7 @@ $ cd build
$ cmake ../ -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DKDE_INSTALL_USE_QT_SYS_PATHS=ON
$ make
Manual installation (this *will* loiter in your system):
Manual installation (this *will* litter in your system):
$ make install
......
......@@ -27,6 +27,9 @@ typedef struct _WacomDeviceDatabase WacomDeviceDatabase;
namespace Wacom {
/**
* @brief Singleton that provides interface for libwacom tablet definition lookups
*/
class libWacomWrapper {
private:
libWacomWrapper();
......
......@@ -31,9 +31,13 @@ namespace Wacom
class ScreenMapPrivate;
/**
* @brief Contains device mappings for each screen
*
* Can be (de)serialized to be stored in the configuration file
*/
class ScreenMap
{
public:
explicit ScreenMap(const TabletArea& tabletGeometry = TabletArea());
......@@ -57,7 +61,7 @@ public:
private:
Q_DECLARE_PRIVATE(ScreenMap)
ScreenMapPrivate *const d_ptr; // D-Pointer for private members.
ScreenMapPrivate *const d_ptr = nullptr;
}; // CLASS
} // NAMESPACE
......
......@@ -27,6 +27,10 @@ namespace Wacom
class ScreenSpacePrivate;
/**
* @brief Specifies either a specific display output (e.g. HDMI-0) or whole screen
*/
class ScreenSpace
{
......
......@@ -30,9 +30,11 @@ namespace Wacom
{
/**
* A static class with some helper methods to get information about the running X server.
* This should be used by all our classes instead of QX11Info. This way we have all X
* specific stuff in one place.
* @brief Various display info helper functions
*
* Originally used to get informatino about the running X server.
* Since Qt5 has been ported to using QScreen.
* TODO: rename this class or make it a namespace even
*/
class X11Info
{
......
......@@ -25,7 +25,7 @@
namespace Wacom
{
/**
* XInput device visitor.
* @brief XInput device visitor. Used by X11TabletFinder class.
*
* This class allows easy access to xinput devices when using
* \a X11Input::scanDevices().
......@@ -33,7 +33,7 @@ namespace Wacom
class X11InputVisitor
{
public:
virtual ~X11InputVisitor() {};
virtual ~X11InputVisitor() {}
/**
* Called by X11Input when iterating the X11 input devices.
......
......@@ -32,27 +32,15 @@ class DeviceType;
class Property;
/**
* The StylusPageWidget class holds all settings for the stylus/eraser pen.
* Through the xsetwacom interface the widget can manipulate the two buttons,
* tip press curve, absolute/relative mode, double tab speed and across monitor support
* via the Twinview options.
*/
* @brief Provides interface to all settings for the stylus/eraser pen.
*/
class StylusPageWidget : public QWidget
{
Q_OBJECT
public:
/**
* default constructor
* Initialize the widget.
*
* @param parent parent Widget
*/
explicit StylusPageWidget(QWidget *parent = 0);
/**
* default destructor
*/
~StylusPageWidget();
void setTabletId(const QString &tabletId);
......
......@@ -29,6 +29,9 @@ namespace Wacom
class X11EventNotifierPrivate;
/**
* @brief Singleton that listens to X11 events, mainly tablet plug/unplug events
*/
class X11EventNotifier : public EventNotifier, public QAbstractNativeEventFilter
{
Q_OBJECT
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment