Skip to content

Commit 81df2df

Browse files
committed
Document mz_zip_writer_init
1 parent 64d92e1 commit 81df2df

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

miniz_zip.h

+3
Original file line numberDiff line numberDiff line change
@@ -348,8 +348,11 @@ mz_bool mz_zip_end(mz_zip_archive *pZip);
348348
#ifndef MINIZ_NO_ARCHIVE_WRITING_APIS
349349

350350
/* Inits a ZIP archive writer. */
351+
/*Set pZip->m_pWrite (and pZip->m_pIO_opaque) before calling mz_zip_writer_init or mz_zip_writer_init_v2*/
352+
/*The output is streamable, i.e. file_ofs in mz_file_write_func always increases only by n*/
351353
mz_bool mz_zip_writer_init(mz_zip_archive *pZip, mz_uint64 existing_size);
352354
mz_bool mz_zip_writer_init_v2(mz_zip_archive *pZip, mz_uint64 existing_size, mz_uint flags);
355+
353356
mz_bool mz_zip_writer_init_heap(mz_zip_archive *pZip, size_t size_to_reserve_at_beginning, size_t initial_allocation_size);
354357
mz_bool mz_zip_writer_init_heap_v2(mz_zip_archive *pZip, size_t size_to_reserve_at_beginning, size_t initial_allocation_size, mz_uint flags);
355358

0 commit comments

Comments
 (0)