Reinserts original comments

qt6-after/qt6-migrated-legatus/TetraIF/LogView/LogViewWidget.hpp

@@ -1,15 +1,15 @@
-
-
-
-
-
-
-
-
-
-
-
-
+// **************************************************************************
+//
+//  (C) Copyright 2009   Swiss SIMTEC AG
+//
+// **************************************************************************
+//
+//  $HeadURL$
+//  $LastChangedBy$
+//  $LastChangedDate$
+//  $LastChangedRevision$
+//
+// **************************************************************************
 
 #pragma once
 
@@ -36,8 +36,11 @@ inline QString toBin(T num)
 class LogViewField;
 class LogViewTelegram;
 
-
-
+/**
+   * @author alois.wismer
+   * @version 1.0
+   * @created 20-Mai-2010 14:51:17
+   */
 class LogViewWidget
 {
 public:
@@ -48,12 +51,17 @@ public:
   LogViewField* field() const { return m_Field; }
   bool isValid() const { return m_Valid; }
 
-  
-
+  /**
+     * The content if the field is a text-field
+     */
   QString getText() const { return m_Text; }
 
-  
-
+  /**
+     * Writes the content into telegram.
+     * Returns true if successful.
+     *
+     * @param a_telegram
+     */
   virtual bool saveContent(LogViewTelegram* a_telegram) = 0;
 
 protected:
@@ -61,16 +69,25 @@ protected:
   void updateToolTip(const QString &a_text = QString());
   double getFloat(const QString& a_text, uint64_t& a_FloatAsData, bool& a_ok, const bool a_reverse = false);
 
-  
-
+  /**
+     * Converts a_text into a signed integer and returns it. The parameter a_ok will
+     * be true if all was successful. The attribute m_Valid will be set to a_ok.
+     * The range will be checked, if the value is out of range, an error will be shown
+     * as messge-box and a_ok will be false.
+     * The input a_text can be a calculation.
+     *
+     * @param a_text
+     * @param a_ok
+     */
   int64_t getInteger(const QString& a_text, bool& a_ok);
 
 
 protected:
   bool m_Readonly;
   bool m_Valid;
-  
-
+  /**
+     * The content if the field is a text-field
+     */
   QString m_Text;
   QString m_LastErrorValueText;
   QWidget *m_Widget;