fix coverity 709295

[kdenlive] / src / lib / audio / audioCorrelationInfo.h

diff --git a/src/lib/audio/audioCorrelationInfo.h b/src/lib/audio/audioCorrelationInfo.h
index 6bb5b8b7c3f94db2f5d90b401d07b13ff6a220fe..f764470e9e50036a0714193694f77292f52a7ca3 100644 (file)
--- a/src/lib/audio/audioCorrelationInfo.h
+++ b/src/lib/audio/audioCorrelationInfo.h
@@ -13,6 +13,8 @@
 
 #include <QImage>
 
+#include <sys/types.h>
+
 /**
   This class holds the correlation of two audio samples.
   It is mainly a container for data, the correlation itself is calculated
@@ -28,9 +30,16 @@ public:
     int64_t* correlationVector();
     int64_t const* correlationVector() const;
 
+    /**
+      Returns the maximum value in the correlation vector.
+      If it has not been set before with setMax(), it will be calculated.
+      */
     int64_t max() const;
     void setMax(int64_t max); ///< Can be set to avoid calculating the max again in this function
 
+    /**
+      Returns the index of the largest value in the correlation vector
+      */
     int maxIndex() const;
 
     QImage toImage(int height = 400) const;