Browse Source

core/crypto: Fix/add some documentation (NFC)

Yawning Angel 1 year ago
parent
commit
c9c0b9ea7b
2 changed files with 5 additions and 2 deletions
  1. 0 1
      core/crypto/aes/aes.odin
  2. 5 1
      core/crypto/crypto.odin

+ 0 - 1
core/crypto/aes/aes.odin

@@ -6,7 +6,6 @@ See:
 - https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38a.pdf
 - https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38a.pdf
 - https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
 - https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
 */
 */
-
 package aes
 package aes
 
 
 import "core:crypto/_aes"
 import "core:crypto/_aes"

+ 5 - 1
core/crypto/crypto.odin

@@ -60,7 +60,11 @@ rand_bytes :: proc (dst: []byte) {
 	_rand_bytes(dst)
 	_rand_bytes(dst)
 }
 }
 
 
-
+// random_generator returns a `runtime.Random_Generator` backed by the
+// system entropy source.
+//
+// Support for the system entropy source can be checked with the
+// `HAS_RAND_BYTES` boolean constant.
 random_generator :: proc() -> runtime.Random_Generator {
 random_generator :: proc() -> runtime.Random_Generator {
 	return {
 	return {
 		procedure = proc(data: rawptr, mode: runtime.Random_Generator_Mode, p: []byte) {
 		procedure = proc(data: rawptr, mode: runtime.Random_Generator_Mode, p: []byte) {