From 2eebd129cf22bef738fa0c6b5828bb4eb6ba467b Mon Sep 17 00:00:00 2001
From: Marco Martin <notmart@gmail.com>
Date: Wed, 14 Sep 2016 11:34:55 +0200
Subject: [PATCH] docs for systray/spacer/devnotifier/systemmonitor

Summary:
config keys documentation for
* systray
* panel spacer
* device notifier
* system monitor

Reviewers: #plasma

Subscribers: plasma-devel

Tags: #plasma

Differential Revision: https://phabricator.kde.org/D2769
---
 .../package/contents/config/main.xml          |  4 ++++
 applets/panelspacer/contents/config/main.xml  |  4 +++-
 .../common/contents/config/main.xml           |  1 +
 .../package/contents/config/main.xml          | 20 +++++++++++--------
 4 files changed, 20 insertions(+), 9 deletions(-)

diff --git a/applets/devicenotifier/package/contents/config/main.xml b/applets/devicenotifier/package/contents/config/main.xml
index bf619d8e8..f5e841988 100644
--- a/applets/devicenotifier/package/contents/config/main.xml
+++ b/applets/devicenotifier/package/contents/config/main.xml
@@ -7,15 +7,19 @@
 
   <group name="General">
     <entry name="removableDevices" type="Bool">
+      <label>If true it lists removable devices, such as USB thumbdrives.</label>
       <default>true</default>
     </entry>
     <entry name="nonRemovableDevices" type="Bool">
+      <label>If true it lists non removable devices, such as internal harddrives.</label>
       <default>false</default>
     </entry>
     <entry name="allDevices" type="Bool">
+      <label>If true it lists all kind of devices.</label>
       <default>false</default>
     </entry>
     <entry name="popupOnNewDevice" type="Bool">
+      <label>If true it tries to open the plasmoid when a new device is inserted, as a kind of notification.</label>
       <default>true</default>
     </entry>
   </group>
diff --git a/applets/panelspacer/contents/config/main.xml b/applets/panelspacer/contents/config/main.xml
index 93f39a415..1f5e3505d 100644
--- a/applets/panelspacer/contents/config/main.xml
+++ b/applets/panelspacer/contents/config/main.xml
@@ -7,10 +7,12 @@
 
   <group name="General">
     <entry name="expanding" type="bool">
+        <label>If true, the spacer tries to take all the available space in the panel.</label>
         <default>true</default>
     </entry>
     <entry name="length" type="Int">
+        <label>length in pixels of the spacer. Configuration effective only if expanding is set to false.</label>
     </entry>
   </group>
 
-</kcfg>
\ No newline at end of file
+</kcfg>
diff --git a/applets/systemmonitor/common/contents/config/main.xml b/applets/systemmonitor/common/contents/config/main.xml
index 18c84f617..1ec8af24c 100644
--- a/applets/systemmonitor/common/contents/config/main.xml
+++ b/applets/systemmonitor/common/contents/config/main.xml
@@ -7,6 +7,7 @@
 
   <group name="General">
     <entry name="sources" type="StringList">
+        <label>Which "systemmonitor" dataengine sources this applet will take data from.</label>
     </entry>
   </group>
 
diff --git a/applets/systemtray/package/contents/config/main.xml b/applets/systemtray/package/contents/config/main.xml
index b74716697..48f5dbe8c 100644
--- a/applets/systemtray/package/contents/config/main.xml
+++ b/applets/systemtray/package/contents/config/main.xml
@@ -6,46 +6,50 @@
   <kcfgfile name=""/>
 
   <group name="General">
-    <entry name="taskPreferences" type="StringList">
-      <default></default>
-    </entry>
-    <entry name="debug" type="bool">
-      <default>false</default>
-    </entry>
     <entry name="applicationStatusShown" type="bool">
+      <label>If true, the items of "Application status" category are shown in the systray.</label>
       <default>true</default>
     </entry>
     <entry name="communicationsShown" type="bool">
+      <label>If true, the items of "Communications" category are shown in the systray.</label>
       <default>true</default>
     </entry>
     <entry name="systemServicesShown" type="bool">
+      <label>If true, the items of "System services" category are shown in the systray.</label>
       <default>true</default>
     </entry>
     <entry name="hardwareControlShown" type="bool">
+      <label>If true, the items of "Hardware Control" category are shown in the systray.</label>
       <default>true</default>
     </entry>
     <entry name="miscellaneousShown" type="bool">
+      <label>If true, the items of "miscellaneous" category are shown in the systray.</label>
       <default>true</default>
     </entry>
 
     <entry name="extraItems" type="StringList">
+      <label>All plasmoid items that are explicitly enabled in the systray. It's a comma-separated string list of plasmoid plugin ids.</label>
       <default></default>
     </entry>
     <entry name="hiddenItems" type="StringList">
+      <label>All items that are hidden, forced always in the popup. It's a comma-separated string list of unique identifiers that are either plasmoid plugin ids or StatusNotifier ids.</label>
       <default></default>
     </entry>
     <entry name="shownItems" type="StringList">
+      <label>All items that are shown. It's a comma-separated string list of unique identifiers that are either plasmoid plugin ids or StatusNotifier ids.</label>
       <default></default>
     </entry>
     <entry name="showAllItems" type="bool">
+        <label>If true, all systray entries will be always in the main area, outside the popup.</label>
         <default>false</default>
     </entry>
-    <!-- All the plasmoids the applet knows of. a plasmoid will be automatically added
-         if X-KDE-PluginInfo-EnabledByDefault=true and is not in the known list-->
     <entry name="knownItems" type="StringList">
+        <label>All the plasmoids the applet knows of. a plasmoid will be automatically added
+         if X-KDE-PluginInfo-EnabledByDefault=true and is not in the known list.</label>
       <default></default>
     </entry>
     <entry name="iconSize" type="Int">
+      <label>Default icon size for the systray icons, it's an enum which values mean, Small, SmallMedium, Medium, Large, Huge, Enormous respectively. On low DPI systems they correspond to 16, 22, 32, 48, 64, 128 pixels. On high DPI systems those values would be scaled up, depending on the DPI.</label>
       <default>1</default>
     </entry>
   </group>