AuroraMiddleware/flac
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fix verbiage about get_block() in Iterator class

Browse Source
This commit is contained in:
Josh Coalson 2002-12-28 07:03:26 +00:00
parent 21cd7b828a
commit 8b9a477a8c
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
include/FLAC++/metadata.h
View File

@ -799,19 +799,19 @@ namespace FLAC {
* - Write changes back to FLAC file with Chain::write()
* - Destroy the Chain instance
*
* The ownership of pointers in the C++ layer follows that in
* the C layer, i.e.
* - The objects returned by Iterator::get_block() are
* owned by the iterator and should not be deleted.
* When you modify the block, you are directly editing
* what's in the chain and do not need to call
* Iterator::set_block(). However the changes will not
* be reflected in the FLAC file until the chain is
* written with Chain::write().
* The ownership of pointers in the C++ layer is slightly
* different than in the C layer, i.e.
* - The objects returned by Iterator::get_block() are NOT
* owned by the iterator and should be deleted by the
* caller when finished, BUT, when you modify the block,
* it will directly edit what's in the chain and you do
* not need to call Iterator::set_block(). However the
* changes will not be reflected in the FLAC file until
* the chain is written with Chain::write().
* - When you pass an object to Iterator::set_block(),
* Iterator::insert_block_before(), or
* Iterator::insert_block_after(), the iterator takes
* ownership of the block and it will be deleted with the
* ownership of the block and it will be deleted by the
* chain.
*
* See the \link flac_metadata_level2 C layer equivalent \endlink