Review and fixes
[situare] / src / ui / userinfo.h
index 0e51cd7..9e582aa 100644 (file)
@@ -77,9 +77,9 @@ protected:
     /**
      * @brief This function is called when the widget is drawn
      *
-     * @param aPaintEvent Pointer to paint event
+     * @param event Pointer to paint event
      */
-    void paintEvent(QPaintEvent *aPaintEvent);
+    void paintEvent(QPaintEvent *event);
 
 /******************************************************************************
 * MEMBER FUNCTIONS AND SLOTS
@@ -143,7 +143,6 @@ public slots:
     void setMessageText(const QString &text);
 
 private:
-
     /**
      * @brief reads Unsend message from settings at startup
      */
@@ -157,16 +156,22 @@ private:
     void setText(bool expanded);
 
     /**
-     * @brief Set shortened texts from User data.
+     * @brief Elides long text
      *
-     * Text length is defined by MAXIMUM_CHARS.
+     * @param label get the fontmetrics from the label
+     * @param text long text to be shortened
+     * @param textMaxWidth label width
+     * @returns shortened text
      */
     QString shortenText(const QLabel *label, const QString &text, int textMaxWidth);
 
     /**
      * @brief Split too long words.
      *
-     * Word Reference to long word
+     * Splits long word to several by adding extra spaces
+     *
+     * @param word long word to be splitted
+     * @returns splitted word
      */
     QString splitWord(const QString &word) const;