[kde-doc-english] [kdeconnect-kde] /: Introduce bare documentation for the KDE Connect kcm

Aleix Pol aleixpol at kde.org
Mon Oct 19 01:29:41 UTC 2015


Git commit 661fa098d48606ea87d6fdb8086dabf8df3366f9 by Aleix Pol.
Committed on 19/10/2015 at 01:25.
Pushed by apol into branch 'master'.

Introduce bare documentation for the KDE Connect kcm

M  +4    -0    CMakeLists.txt
A  +1    -0    doc/CMakeLists.txt
A  +37   -0    doc/index.docbook
M  +1    -1    kcm/kcm.cpp
M  +2    -0    kcm/kcm_kdeconnect.desktop

http://commits.kde.org/kdeconnect-kde/661fa098d48606ea87d6fdb8086dabf8df3366f9

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 4856bee..c789840 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -12,6 +12,7 @@ set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${ECM_KDE_MODULE_DIR} ${CMAKE_SOURCE_DI
 
 find_package(Qt5 5.2 REQUIRED COMPONENTS Quick)
 find_package(KF5 REQUIRED COMPONENTS I18n ConfigWidgets DBusAddons IconThemes)
+find_package(KF5DocTools)
 find_package(Qca-qt5 2.1.0 REQUIRED)
 find_package(TelepathyQt5 0.9.5)
 find_package(TelepathyQt5Service 0.9.7)
@@ -54,6 +55,9 @@ add_subdirectory(plugins)
 add_subdirectory(plasmoid)
 add_subdirectory(cli)
 add_subdirectory(fileitemactionplugin)
+if(KF5DocTools_FOUND)
+    add_subdirectory(doc)
+endif()
 
 if (TelepathyQt5_FOUND AND TelepathyQt5Service_FOUND)
     add_subdirectory(telepathy-cm)
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 0000000..df281f5
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1 @@
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kdeconnect)
diff --git a/doc/index.docbook b/doc/index.docbook
new file mode 100644
index 0000000..1b1e13d
--- /dev/null
+++ b/doc/index.docbook
@@ -0,0 +1,37 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
+"dtd/kdedbx45.dtd" [
+<!ENTITY % addindex "IGNORE">
+<!ENTITY % English "INCLUDE" > <!-- change language only here -->
+]>
+
+<article id="kdeconnect" lang="&language;">
+<articleinfo>
+<title>KDE Connect</title>
+<authorgroup>
+<author>&Aleix.Pol;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2015-10-19</date>
+<releaseinfo>0.9</releaseinfo>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>Connect</keyword>
+<keyword>phone</keyword>
+<keyword>remote</keyword>
+<keyword>device</keyword>
+<keyword>pair</keyword>
+</keywordset>
+</articleinfo>
+
+<sect1 id="kdeconnect-kcm">
+
+<title>KDE Connect</title>
+
+<para>You can use this dialog to configure which devices we're paired to. It's useful since it will specify who we're sharing information with.</para>
+
+</sect1>
+
+</article>
diff --git a/kcm/kcm.cpp b/kcm/kcm.cpp
index 98d5bb6..329b168 100644
--- a/kcm/kcm.cpp
+++ b/kcm/kcm.cpp
@@ -85,7 +85,7 @@ KdeConnectKcm::KdeConnectKcm(QWidget *parent, const QVariantList&)
     kcmUi->rename_edit->setText(daemon->announcedName());
     setRenameMode(false);
 
-    setButtons(KCModule::NoAdditionalButton);
+    setButtons(KCModule::Help | KCModule::NoAdditionalButton);
 
     connect(devicesModel, SIGNAL(dataChanged(QModelIndex,QModelIndex)),
             this, SLOT(resetSelection()));
diff --git a/kcm/kcm_kdeconnect.desktop b/kcm/kcm_kdeconnect.desktop
index 83a5968..c9de1fb 100755
--- a/kcm/kcm_kdeconnect.desktop
+++ b/kcm/kcm_kdeconnect.desktop
@@ -91,4 +91,6 @@ X-KDE-Keywords[uk]=Network,Android,Devices,мережа,андроїд,прис
 X-KDE-Keywords[x-test]=xxNetworkxx,xxAndroidxx,xxDevicesxx
 X-KDE-Keywords[zh_CN]=Network,Android,Devices,网络,安卓,设备
 
+X-DocPath=kdeconnect/index.html
+
 Categories=Qt;KDE;X-KDE-settings-kdeconnect;


More information about the kde-doc-english mailing list