summaryrefslogtreecommitdiffstats
path: root/src/audio
diff options
context:
space:
mode:
authorJan Holthuis <jholthuis@mixxx.org>2021-07-01 12:47:44 +0200
committerJan Holthuis <jholthuis@mixxx.org>2021-07-01 16:39:40 +0200
commitdb6b5f61560a16624f9d8a9802479aac46e04022 (patch)
tree167989fa97f7a4337962d72639c633f55c39b9cf /src/audio
parent7a05af6d9c66a6a794406f1d07dc06c29b81af18 (diff)
FramePos: Clean up comments
Diffstat (limited to 'src/audio')
-rw-r--r--src/audio/frame.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/audio/frame.h b/src/audio/frame.h
index 32ff916650..93096e6152 100644
--- a/src/audio/frame.h
+++ b/src/audio/frame.h
@@ -57,15 +57,17 @@ class FramePos final {
value_t m_dFramePos;
};
-// FramePos can be added to and subtracted from a FrameDiff_t
+/// FramePos can be added to a FrameDiff_t
inline FramePos operator+(FramePos framePos, FrameDiff_t frameDiff) {
return FramePos(framePos.getValue() + frameDiff);
}
+/// FramePos can be subtracted from a FrameDiff_t
inline FramePos operator-(FramePos framePos, FrameDiff_t frameDiff) {
return FramePos(framePos.getValue() - frameDiff);
}
+/// Two FramePos can be subtracted to get a FrameDiff_t
inline FrameDiff_t operator-(FramePos framePos1, FramePos framePos2) {
return framePos1.getValue() - framePos2.getValue();
}
@@ -73,7 +75,7 @@ inline FrameDiff_t operator-(FramePos framePos1, FramePos framePos2) {
// Adding two FramePos is not allowed since every FramePos shares a common
// reference or origin i.e. the start of the track.
-// FramePos can be multiplied or divided by a double
+/// FramePos can be multiplied or divided by a double
inline FramePos operator*(FramePos framePos, double multiple) {
return FramePos(framePos.getValue() * multiple);
}