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.

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

Add documentation to libsodium bindings API #3

Open
4 of 15 tasks
ionspin opened this issue Oct 23, 2020 · 0 comments
Open
4 of 15 tasks

Add documentation to libsodium bindings API #3

ionspin opened this issue Oct 23, 2020 · 0 comments

Comments

@ionspin
Copy link
Owner

ionspin commented Oct 23, 2020

Describe the bug
Documentation of the Libsodium bindings API is either completely missing, or a direct copy from libsodium website

To Reproduce
Look at the API documentation

Expected behavior
A documentation explaining what a method/function does precisely

Platform

  • All

Tasks:
Add .md description for each functionality group and add documentation for each function in the group

  • aead
  • auth
  • box
  • generichash
  • hash
  • kdf
  • keyexchange
  • pwhash
  • scalarmult
  • secretbox
  • secretstream
  • shortinputhash
  • signature
  • stream
  • util
@ionspin ionspin transferred this issue from ionspin/kotlin-multiplatform-crypto Jan 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant