From 6778a41c58e60756cfb78888e3b2a8e262190426 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Wed, 19 Jun 2019 11:35:24 +0200 Subject: [PATCH] Migrate serialportcommander plugin documentation --- serialportcommander/README.md | 3 +++ .../devicepluginserialportcommander.cpp | 17 ----------------- 2 files changed, 3 insertions(+), 17 deletions(-) create mode 100644 serialportcommander/README.md diff --git a/serialportcommander/README.md b/serialportcommander/README.md new file mode 100644 index 00000000..9f7b4fc0 --- /dev/null +++ b/serialportcommander/README.md @@ -0,0 +1,3 @@ +# Serial port commander + +This plugin allowes to send and receive custom serial port commands and integrate them into the rule engine. This plugin is ment as a generic approach for developers and assumes you know which data is coming form a serial device and how the API looks like. \ No newline at end of file diff --git a/serialportcommander/devicepluginserialportcommander.cpp b/serialportcommander/devicepluginserialportcommander.cpp index 6f203946..56745191 100644 --- a/serialportcommander/devicepluginserialportcommander.cpp +++ b/serialportcommander/devicepluginserialportcommander.cpp @@ -20,23 +20,6 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -/*! - \page serialportcommander.html - \title Serial Port Commander - \brief Plug-In to send and receive strings over a serial port. - - \ingroup plugins - \ingroup nymea-plugins - - \chapter Plugin properties - Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses} - and \l{Vendor}{Vendors} of this \l{DevicePlugin}. - - For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}. - - \quotefile plugins/deviceplugins/serialportcommander/devicepluginserialportcommander.json -*/ - #include "devicepluginserialportcommander.h" #include "plugininfo.h"