Commit 6388d550 authored by Frederik Gladhorn's avatar Frederik Gladhorn Committed by Frederik Gladhorn

Improve documentation

Summary:
Some of the documentation did not say what the purpose of the
respective class was, but rather gave a tautology.
For people new to the code base it helps to mention that
DPMS is power management.

That DataDevice is for copy-and-paste and drag-and-drop is
maybe obvious to people used to X11 API, but not very clear
to most others.

When first reading the KWayland code, some explanations
help getting around.

Reviewers: #kwin, romangg

Reviewed By: #kwin, romangg

Subscribers: romangg, zzag, kde-frameworks-devel

Tags: #frameworks

Differential Revision: https://phabricator.kde.org/D23915
parent 21319809
......@@ -36,7 +36,7 @@ class DataSource;
class Surface;
/**
* @short Wrapper for the wl_data_device interface.
* @short DataDevice allows clients to share data by copy-and-paste and drag-and-drop.
*
* This class is a convenient wrapper for the wl_data_device interface.
* To create a DataDevice call DataDeviceManager::getDataDevice.
......
......@@ -37,9 +37,9 @@ class Dpms;
class Output;
/**
* @short Wrapper for the org_kde_kwin_dpms_manager interface.
* @short This class is a factory for Dpms instances.
*
* This class provides a convenient wrapper for the org_kde_kwin_dpms_manager interface.
* It is a convenience wrapper for the org_kde_kwin_dpms_manager interface.
*
* To use this class one needs to interact with the Registry. There are two
* possible ways to create the DpmsManager interface:
......@@ -57,7 +57,7 @@ class Output;
* The DpmsManager can be used as a drop-in replacement for any org_kde_kwin_dpms_manager
* pointer as it provides matching cast operators.
*
* @see Registry
* @see Registry, Dpms
* @since 5.5
**/
class KWAYLANDCLIENT_EXPORT DpmsManager : public QObject
......@@ -134,8 +134,9 @@ private:
};
/**
* @short Wrapper for the org_kde_kwin_dpms interface.
* @short Power management for monitors.
*
* Display Power Management Signaling allows power management for monitors.
* This class is a convenient wrapper for the org_kde_kwin_dpms interface.
* To create a Dpms call DpmsManager::getDpms.
*
......
......@@ -38,7 +38,12 @@ class SeatInterface;
class SurfaceInterface;
/**
* @brief Represents the Resource for the wl_data_device interface.
* @brief DataDeviceInterface allows clients to share data by copy-and-paste and drag-and-drop.
*
* The data device is per seat.
* Copy-and-paste use the selection functions.
*
* Represents the Resource for the wl_data_device interface.
*
* @see SeatInterface
* @see DataSourceInterface
......
......@@ -33,12 +33,13 @@ namespace Server
class Display;
/**
* @brief Global for the org_kde_kwin_dpms_manager interface.
* @brief Global for server side Display Power Management Signaling interface.
*
* If the DpmsManagerInterface is created it allows a client to
* query the Dpms state on a given OutputInterface and request
* changes for it. The code interaction happens only via the
* OutputInterface.
* A DpmsManagerInterface allows a client to query the DPMS state
* on a given OutputInterface and request changes to it.
* Server-side the interaction happens only via the OutputInterface,
* for clients the Dpms class provides the API.
* This global implements org_kde_kwin_dpms_manager.
*
* To create a DpmsManagerInterface use:
* @code
......
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