From: Carl Hetherington <cth@carlh.net>
Date: Fri, 14 Oct 2022 08:41:16 +0000 (+0200)
Subject: Add a comment.
X-Git-Tag: v2.16.31~16
X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=dff5862bd740981e23234a74f4658df9f4b8ae9c

Add a comment.
---

diff --git a/src/lib/player.h b/src/lib/player.h
index b6ee4e9c6..3dbc1c034 100644
--- a/src/lib/player.h
+++ b/src/lib/player.h
@@ -99,6 +99,10 @@ public:
 	boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<const Content> content, dcpomatic::ContentTime t) const;
 	boost::optional<dcpomatic::ContentTime> dcp_to_content_time (std::shared_ptr<const Content> content, dcpomatic::DCPTime t) const;
 
+	/** First parameter is PENDING, DONE or CANCELLED.
+	 *  Second parameter is the property.
+	 *  Third parameter is true if these signals are currently likely to be frequent.
+	 */
 	boost::signals2::signal<void (ChangeType, int, bool)> Change;
 
 	/** Emitted when a video frame is ready.  These emissions happen in the correct order. */