summaryrefslogtreecommitdiff
path: root/lib/binstruct
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@lukeshu.com>2023-03-16 18:38:11 -0400
committerLuke Shumaker <lukeshu@lukeshu.com>2023-03-17 02:51:41 -0400
commit2ee7091933d2c07338dfb4699ce5665951b47afd (patch)
treeae0dc5b84e68890c79d13e5694a38f1a59a64d07 /lib/binstruct
parent1d52c7513c5bca088fd8e44ff56d07c44e806967 (diff)
tree-wide: Ensure that all packages have a doc comment
Diffstat (limited to 'lib/binstruct')
-rw-r--r--lib/binstruct/binutil/binutil.go4
-rw-r--r--lib/binstruct/unmarshal.go3
2 files changed, 6 insertions, 1 deletions
diff --git a/lib/binstruct/binutil/binutil.go b/lib/binstruct/binutil/binutil.go
index 684237f..a5c65b5 100644
--- a/lib/binstruct/binutil/binutil.go
+++ b/lib/binstruct/binutil/binutil.go
@@ -1,7 +1,9 @@
-// Copyright (C) 2022 Luke Shumaker <lukeshu@lukeshu.com>
+// Copyright (C) 2022-2023 Luke Shumaker <lukeshu@lukeshu.com>
//
// SPDX-License-Identifier: GPL-2.0-or-later
+// Package binutil provides utilities for implementing the interfaces
+// consumed by binstruct.
package binutil
import (
diff --git a/lib/binstruct/unmarshal.go b/lib/binstruct/unmarshal.go
index eae4b84..41aab9c 100644
--- a/lib/binstruct/unmarshal.go
+++ b/lib/binstruct/unmarshal.go
@@ -2,6 +2,9 @@
//
// SPDX-License-Identifier: GPL-2.0-or-later
+// Package binstruct implements simple struct-tag-based conversion
+// between Go structures and binary on-disk representations of that
+// data.
package binstruct
import (