Documenting md5 feature

This commit is contained in:
Jay McCarthy 2010-08-19 16:32:19 -06:00
parent 16f1dffe4c
commit 209d2a0cda

View File

@ -10,12 +10,15 @@
@defmodule[file/md5] @defmodule[file/md5]
@defproc[(md5 [in (or/c input-port? bytes? string?)]) bytes?]{ @defproc[(md5 [in (or/c input-port? bytes? string?)]
[hex-encode? boolean? #t]) bytes?]{
Produces a byte string containing 32 hexadecimal digits (lowercase) If @racket[hex-encode?] is @racket[#t], produces a byte string containing 32 hexadecimal digits (lowercase)
that is the MD5 hash of the given input stream or byte string. Otherwise produces the 16 byte long byte string
that is the MD5 hash of the given input stream or byte string. that is the MD5 hash of the given input stream or byte string.
@examples[ @examples[
#:eval md5-eval #:eval md5-eval
(md5 #"abc") (md5 #"abc")
(md5 #"abc" #f)
]} ]}