8000 Any document to descript the APIs? · Issue #445 · zlib-ng/minizip-ng · GitHub
[go: up one dir, main page]

Skip to content
8000

Any document to descript the APIs? #445

Closed

Description

@willson-chen

I am a beginner to minizip. Is there any document or example to describe how to use APIs?

Activity

  1. willson-chen commented on Jan 16, 2020

    @willson-chen
    Author

    minizip.c can be considered as an example. But it is a little complicate.

    And I am looking for a document to specific every API's action, input param and return value. Please drop me a link of the doc. thx!

  2. nmoinvaz commented on Jan 17, 2020

    @nmoinvaz
    Member

    Currently I don't have any document that does that. There is some code at the bottom of the Wiki on this GitHub but that is it. This issue is probably a duplicate of #426.

  3. willson-chen commented on Jan 18, 2020

    @willson-chen
    Author

    @nmoinvaz , and any plan to accept PR of such document, please?

  4. nmoinvaz commented on Jan 18, 2020

    @nmoinvaz
    Member

    I am willing to accept PR of a document in markdown format.

  5. willson-chen commented on Jan 19, 2020

    @willson-chen
    Author

    @nmoinvaz , hi,

    I will try to contribute to the doc. But I need your help when necessary. :)

    What about a file named HowToUse.md, located under doc dir?

    Here is the first level subtitle should be included I think:

    • What is minizip: a short description.
    • Example: one or two simple examples to demonstrate how to use minizip to zip and unzip files.
    • API reference: specific the input parameter and return value for each API. Considering the amount of APIs, this part will take a long time.

    BTW, do you have other social account so that I could send direct message to ask for help? Is your email in git log avaible?

    Many thanks!

  6. nmoinvaz commented on Jan 19, 2020

    @nmoinvaz
    Member

    That sounds like a good start. In think showing the distrinctions between mz_zip (which can work directly with the archive) and mz_zip_reader/mz_zip_writer (which works with the file system to build or extract the archive) is an important distrinction to make. Also mz_compat is used for the compatibility layer and can also work directly with the archive. Yes I am available via the email on git log. Thanks for your help!

  7. willson-chen commented on Jan 22, 2020

    @willson-chen
    Author

    That sounds like a good start. In think showing the distrinctions between mz_zip (which can work directly with the archive) and mz_zip_reader/mz_zip_writer (which works with the file system to build or extract the archive) is an important distrinction to make. Also mz_compat is used for the compatibility layer and can also work directly with the archive. Yes I am available via the email on git log. Thanks for your help!

    I think I need some time to understand the code of minizip.

    You are saying, there are THREE series of API to zip/unzip archive?

    1. mz_zip
    2. mz_zip_reader/mz_zip_writer
    3. mz_compat
  8. nmoinvaz commented on Jan 22, 2020

    @nmoinvaz
    Member

    Yes that is correct, there are three different APIs.

    • mz_zip handles zip archive file format, it allows you direct access the zip entries and their properties.
    • mz_zip_reader/mz_zip_writer is an easier to use interface than mz_zip to extract files to disk or compress them. It uses mz_zip but it handles all file system handling such as updating a file's last modified time, or enumerating directories to compress all the files.
    • mz_compat uses mz_zip underneath to provide a minizip 1.x compatibility layer. It operates at the same level as mz_zip
  9. nmoinvaz commented on Feb 8, 2020

    @nmoinvaz
    Member

    I think this issue is a duplicate of #426. Please see that issue for further discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation updatefixedIssue or bug has been fixed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      0