added small code example

2020-04-08 18:56:37 +02:00 · 2020-04-08 18:56:37 +02:00 · d531950a0b
parent e9971cab79
commit d531950a0b
1 changed files with 6 additions and 0 deletions
--- a/ScStwLibraries/scstwclient.h
+++ b/ScStwLibraries/scstwclient.h
@ -19,6 +19,12 @@
 /**
 * This class is used to connect and talk to the ScStw basestation.
 *
+ * @code{.cpp}
+ *  ScStwClient * client = new ScStwClient();
+ *  client->setIp("192.168.4.1");
+ *  client->connectToHost();
+ * @endcode
+ *
 * @brief The ScStwClient class
 * @author Dorian Zedler
 */