Skip to content

Commit ec663ed

Browse files
committed
Reorganized API documentation.
1 parent b543f19 commit ec663ed

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

docs/src/api.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
11
# API
22

3-
```@index
4-
```
5-
63
```@meta
74
CurrentModule = ChaChaCiphers
85
```
96

7+
## Keystream types
8+
9+
```@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+
```@autodocs
18+
Modules = [ChaChaCiphers]
19+
Filter = t -> t in (getstate, ChaChaCiphers.ChaChaState)
20+
```
21+
22+
## Encryption and decryption
23+
1024
```@autodocs
1125
Modules = [ChaChaCiphers]
26+
Filter = t -> t in (encrypt!, decrypt!)
27+
```
28+
29+
## Index
30+
31+
```@index
1232
```

0 commit comments

Comments
 (0)