Skip to content
Snippets Groups Projects
Commit 39142986 authored by Peter Albrecht's avatar Peter Albrecht
Browse files

Added documentation for ConnectionStatusLabel

parent ef7c71b3
No related branches found
No related tags found
1 merge request!420Add documentation to skill memory gui
Pipeline #16900 passed
......@@ -5,6 +5,10 @@
namespace armarx::skills::gui
{
/**
* @brief The ConnectionStatusLabel class is a label, which can accept a message to show for a
* defined amount of time. After this time, the message disappears.
*/
class ConnectionStatusLabel : public QLabel
{
public:
......@@ -16,7 +20,7 @@ namespace armarx::skills::gui
public slots:
/**
* @brief Display a message to indicate a connection drop.
* @brief Display a message.
*/
void handleMessage(std::string const& message);
......@@ -27,7 +31,14 @@ namespace armarx::skills::gui
void resetLabel();
private:
/**
* @brief The timer handling the time, for which to show the message.
*/
QTimer* timer = nullptr;
/**
* @brief The time, for which to show the message, in [ms].
*/
int ms_delay;
};
} // namespace armarx::skills::gui
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment