Added/Updated/Fixed doxygen comments

src/hyperion-remote/JsonConnection.h

@@ -15,48 +15,73 @@
 // hyperion-remote includes
 #include "ColorTransformValues.h"
 
+///
 /// Connection class to setup an connection to the hyperion server and execute commands
+///
 class JsonConnection
 {
 public:
-	/// @brief COnstructor
+	///
+	/// Constructor
+	///
 	/// @param address The address of the Hyperion server (for example "192.168.0.32:19444)
 	/// @param printJson Boolean indicating if the sent and received json is written to stdout
+	///
 	JsonConnection(const std::string & address, bool printJson);
 
-	/// @brief Destructor
+	///
+	/// Destructor
+	///
 	~JsonConnection();
 
-	/// @brief Set all leds to the specified color
+	///
+	/// Set all leds to the specified color
+	///
 	/// @param color The color
 	/// @param priority The priority
 	/// @param duration The duration in milliseconds
+	///
 	void setColor(QColor color, int priority, int duration);
 
-	/// @brief Set the leds according to the given image (assume the image is stretched to the display size)
+	///
+	/// Set the leds according to the given image (assume the image is stretched to the display size)
+	///
 	/// @param image The image
 	/// @param priority The priority
 	/// @param duration The duration in milliseconds
+	///
 	void setImage(QImage image, int priority, int duration);
 
-	/// @brief Retrieve a list of all occupied priority channels
+	///
+	/// Retrieve a list of all occupied priority channels
+	///
 	/// @return String with the server info
+	///
 	QString getServerInfo();
 
-	/// @brief Clear the given priority channel
+	///
+	/// Clear the given priority channel
+	///
 	/// @param priority The priority
+	///
 	void clear(int priority);
 
-	/// @brief Clear all priority channels
+	///
+	/// Clear all priority channels
+	///
 	void clearAll();
 
-	/// @brief Set the color transform of the leds
+	///
+	/// Set the color transform of the leds
+	///
 	/// @note Note that providing a NULL will leave the settings on the server unchanged
+	///
 	/// @param saturation The HSV saturation gain
 	/// @param value The HSV value gain
 	/// @param threshold The threshold
 	/// @param blacklevel The blacklevel
 	/// @param whitelevel The whitelevel
+	///
 	void setTransform(
 			double * saturation,
 			double * value,
@@ -66,18 +91,28 @@ public:
 			ColorTransformValues * whitelevel);
 
 private:
-	/// @brief Send a json command message and receive its reply
+	///
+	/// Send a json command message and receive its reply
+	///
 	/// @param message The message to send
+	///
 	/// @return The returned reply
+	///
 	Json::Value sendMessage(const Json::Value & message);
 
-	/// @brief Parse a reply message
+	///
+	/// Parse a reply message
+	///
 	/// @param reply The received reply
+	///
 	/// @return true if the reply indicates success
+	///
 	bool parseReply(const Json::Value & reply);
 
 private:
+	/// Flag for printing all send and received json-messages to the standard out
 	bool _printJson;
 
+	/// The TCP-Socket with the connection to the server
 	QTcpSocket _socket;
 };