Reinserts original comments

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

@@ -1,15 +1,15 @@
-
-
-
-
-
-
-
-
-
-
-
-
+// **************************************************************************
+//
+//  (C) Copyright 2009   Swiss SIMTEC AG
+//
+// **************************************************************************
+//
+//  $HeadURL$
+//  $LastChangedBy$
+//  $LastChangedDate$
+//  $LastChangedRevision$
+//
+// **************************************************************************
  
 #pragma once
 
@@ -57,8 +57,15 @@ namespace N_LogView
     void addValue(const QString &value);
     void addValueBinaryHex(const QString &value);
 
-    
-
+    /**
+     * Returns the value at position a_index converted to a string. If the field is a
+     * date-time-field, the returned value is converted to a string containing date
+     * and time, execpt when a_doNotMakeSpecialConversions is set to true, the unix-
+     * time will be returned as value.
+     * 
+     * @param a_index
+     * @param a_doNotMakeSpecialConversions
+     */
     QString value(int arrayIdx, const bool a_doNotMakeSpecialConversions = false) const;
     int valueListSize() const { return m_ValueList.size(); }
 
@@ -74,12 +81,21 @@ namespace N_LogView
     int64_t getHighestValue() const;
     int64_t getLowestValue() const;
 
-    
-
+    /**
+     * 
+     * @param a_indent
+     */
     void dump(const QString &a_indent = QString()) const;
 
-    
-
+    /**
+     * Makes the text <a_uncleanText> pretty for human readable. It does following:
+     * - generates umlaute (ä, ö, ü)
+     * - removes _rt at end
+     * - replaces _ with space
+     * - uppercase of every word
+     * 
+     * @param a_uncleanText
+     */
     static QString makeClean(const QString &text);
 
 
@@ -89,8 +105,9 @@ namespace N_LogView
 
     const LogViewXdrElement* xdrElement() const { return m_XdrElement; }
 
-    
-
+    /**
+     * returns true if the field is a date-time
+     */
     bool isDateTimeField() const;
     bool isMSecsField() const;
 
@@ -98,8 +115,9 @@ namespace N_LogView
     uint16_t maxArraySize() const { return m_MaxArraySize; }
     void setMaxArraySize(uint16_t newVal, const bool a_isDynamic);
 
-    
-
+    /**
+     * True if the array is dynamic.
+     */
     bool isDynamicArray() const { return m_IsDynamicArray; }
 
 
@@ -124,8 +142,9 @@ namespace N_LogView
     uint16_t m_Offset;
     int m_Size;
     uint16_t m_MaxArraySize;
-    
-
+    /**
+     * True if the array is dynamic.
+     */
     bool m_IsDynamicArray;
     bool m_HasContent;
     bool m_bDeleteXdr;