diff options
| author | Carl Hetherington <cth@carlh.net> | 2021-02-04 21:33:19 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2021-02-04 21:33:19 +0100 |
| commit | 6f28eb4948be29bb0c273e93bbb161d14e8e071f (patch) | |
| tree | 51b477f976b04565c86702299d2d05ba93e860d0 /src | |
| parent | c2b47febbd178be5e50dcbb3b023f58a0b6441ec (diff) | |
Improve a comment.
Diffstat (limited to 'src')
| -rw-r--r-- | src/mono_picture_asset.h | 8 |
1 files 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<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 ( |