We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent b543f19 commit ec663edCopy full SHA for ec663ed
docs/src/api.md
@@ -1,12 +1,32 @@
1
# API
2
3
-```@index
4
-```
5
-
6
```@meta
7
CurrentModule = ChaChaCiphers
8
```
9
+## Keystream types
+
+```@autodocs
10
+Modules = [ChaChaCiphers]
11
+Filter = t -> (t isa DataType && t <: ChaChaCiphers.AbstractChaChaStream) ||
12
+ t in (ChaCha12Stream, ChaCha20Stream, CUDAChaCha12Stream, CUDAChaCha20Stream)
13
+```
14
15
+## Keystream helpers
16
17
18
19
+Filter = t -> t in (getstate, ChaChaCiphers.ChaChaState)
20
21
22
+## Encryption and decryption
23
24
```@autodocs
25
Modules = [ChaChaCiphers]
26
+Filter = t -> t in (encrypt!, decrypt!)
27
28
29
+## Index
30
31
+```@index
32
0 commit comments