From: Carl Hetherington Date: Thu, 4 Feb 2021 20:33:19 +0000 (+0100) Subject: Improve a comment. X-Git-Tag: v1.8.0~105 X-Git-Url: https://main.carlh.net/gitweb/?p=libdcp.git;a=commitdiff_plain;h=6f28eb4948be29bb0c273e93bbb161d14e8e071f Improve a comment. --- 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 (