Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation #3

Open
10 of 11 tasks
plicease opened this issue May 23, 2021 · 1 comment
Open
10 of 11 tasks

Documentation #3

plicease opened this issue May 23, 2021 · 1 comment

Comments

@plicease
Copy link
Member

plicease commented May 23, 2021 •
edited
Loading

The POD for these modules should provide enough information to be able to use this classes in a useful manner. They DO NOT need to document every single method.

The entire API should be documented for usage (doesn't need a full description, the libarchive documentation / header should be sufficient) here:

  • Archive::Libarchive::API auto-generated methods
  • Archive::Libarchive::API manually written methods with references to the main documentation
  • Archive::Libarchive::API list of methods not implemented
@plicease
Copy link
Member Author

Just need a synopsis for DiskRead to close this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@plicease