Add godoc for AuditFormatWriter methods.

hashicorp · Jul 2, 2019 · 4b31235 · 4b31235
1 parent 9fa7da3
commit 4b31235
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/audit/format.go b/audit/format.go
@@ -17,8 +17,11 @@ import (
 )
 
 type AuditFormatWriter interface {
+	// WriteRequest writes the request entry to the writer or returns an error.
 	WriteRequest(io.Writer, *AuditRequestEntry) error
+	// WriteResponse writes the response entry to the writer or returns an error.
 	WriteResponse(io.Writer, *AuditResponseEntry) error
+	// Salt returns a non-nil salt or an error.
 	Salt(context.Context) (*salt.Salt, error)
 }