Skip to content

Commit

Permalink
Documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeff R. Allen committed Nov 27, 2017
1 parent 462565b commit 91b23e8
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 7 deletions.
8 changes: 8 additions & 0 deletions hash.go
@@ -0,0 +1,8 @@
package kyber

import "hash"

// A HashFactory is an interface that can be mixed in to local suite definitions.
type HashFactory interface {
Hash() hash.Hash
}
9 changes: 2 additions & 7 deletions xof.go
Expand Up @@ -2,7 +2,6 @@ package kyber

import (
"crypto/cipher"
"hash"
"io"
)

Expand All @@ -12,7 +11,8 @@ import (
// state of the XOF.
type XOF interface {
// Write absorbs more data into the hash's state. It panics if called
// after Read. Use Reseed() to
// after Read. Use Reseed() return an XOF into a state where more data
// can be absorbed via Write.
io.Writer

// Read reads more output from the hash. It returns io.EOF if the limit
Expand Down Expand Up @@ -42,8 +42,3 @@ type XOFFactory interface {
// bytes from Read.
XOF(seed []byte) XOF
}

// A HashFactory factors hashes. (Tempory comment to make travis happy. Hash is disappearing soon.)
type HashFactory interface {
Hash() hash.Hash
}
2 changes: 2 additions & 0 deletions xof/blake/blake.go
@@ -1,3 +1,5 @@
// Package blake provides an implementation of kyber.XOF based on the
// Blake2bx construction.
package blake

import (
Expand Down
2 changes: 2 additions & 0 deletions xof/keccak/keccak.go
@@ -1,3 +1,5 @@
// Package keccak provides an implementation of kyber.XOF based on the
// Shake256 hash.
package keccak

import (
Expand Down
2 changes: 2 additions & 0 deletions xof/xof.go
@@ -1 +1,3 @@
// Package XOF holds implementations and testing code for the various
// extendable output functions.
package xof

0 comments on commit 91b23e8

Please sign in to comment.