From 6f28eb4948be29bb0c273e93bbb161d14e8e071f Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Thu, 4 Feb 2021 21:33:19 +0100 Subject: [PATCH] Improve a comment. --- src/mono_picture_asset.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/mono_picture_asset.h b/src/mono_picture_asset.h index f6f8877c..505d3c20 100644 --- a/src/mono_picture_asset.h +++ b/src/mono_picture_asset.h @@ -68,8 +68,12 @@ public: */ explicit MonoPictureAsset (Fraction edit_rate, Standard standard); - /** Start a progressive write to a MonoPictureAsset */ - std::shared_ptr start_write (boost::filesystem::path, bool); + /** Start a progressive write to a MonoPictureAsset. + * @path file File to write to. + * @path overwrite true to overwrite an existing file; for use when continuing a write which + * previously failed. If in doubt, use false here. + */ + std::shared_ptr start_write (boost::filesystem::path file, bool overwrite); std::shared_ptr start_read () const; bool equals ( -- 2.30.2