Improve a comment.
authorCarl Hetherington <cth@carlh.net>
Thu, 4 Feb 2021 20:33:19 +0000 (21:33 +0100)
committerCarl Hetherington <cth@carlh.net>
Thu, 4 Feb 2021 20:33:19 +0000 (21:33 +0100)
src/mono_picture_asset.h

index f6f8877c5e8e9c53484636b8a4b55fe7db47d51f..505d3c20923a9f2292308d2847ddab8e2846ad93 100644 (file)
@@ -68,8 +68,12 @@ public:
         */
        explicit MonoPictureAsset (Fraction edit_rate, Standard standard);
 
         */
        explicit MonoPictureAsset (Fraction edit_rate, Standard standard);
 
-       /** Start a progressive write to a MonoPictureAsset */
-       std::shared_ptr<PictureAssetWriter> 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<PictureAssetWriter> start_write (boost::filesystem::path file, bool overwrite);
        std::shared_ptr<MonoPictureAssetReader> start_read () const;
 
        bool equals (
        std::shared_ptr<MonoPictureAssetReader> start_read () const;
 
        bool equals (