Add JSDoc comments to functions in operator.ts - Githubissues

reclaimprotocol / zk-symmetric-crypto

A circom library for zero-knowledge proofs of symmetric encryption key ownership without key revelation.

6 stars 3 forks source link

Add JSDoc comments to functions in operator.ts #9

Closed varun-doshi closed 3 weeks ago

varun-doshi commented 3 weeks ago

Description

Add JSDoc comments to functions in operator.ts. Namely the following functions:

makeLocalSnarkJsZkOperator
makeSnarkJsZKOperator

Testing (ignore for documentation update)

Type of change

[ ] Bug fix
[ ] New feature
[ ] Breaking change
[x] Documentation update

Checklist:

[x] I have read and agree to the Code of Conduct.
[x] I have signed the Contributor License Agreement (CLA).
[x] I have considered the Security Policy.
[x] I have self-reviewed and tested my code.
[x] I have updated documentation as needed.
[x] I agree to the project's custom license.

Additional Notes:

CLAassistant commented 3 weeks ago

All committers have signed the CLA.

adithyaakrishna commented 3 weeks ago

@varun-doshi Could you pls sign the CLA?

varun-doshi commented 3 weeks ago

Done