More standard deprecation comment for cap.Compare and cap.IABInit

Based on what I see on go.dev, there seems to be some preferred
comment style for deprecating a function. Use it to help spread
the word.

Signed-off-by: Andrew G. Morgan <morgan@kernel.org>

1 files changed, 11 insertions, 1 deletions

diff --git a/cap/iab.go b/cap/iab.go
index 1be921c..90fc436 100644
--- a/cap/iab.go
+++ b/cap/iab.go
@@ -79,7 +79,17 @@ func NewIAB() *IAB {
 	}
 }
 
-// IABInit is a deprecated alias for the NewIAB function.
+// IABInit allocates a new IAB tuple.
+//
+// Deprecated: Replace with NewIAB.
+//
+// Example, replace this:
+//
+//    iab := IABInit()
+//
+// with this:
+//
+//    iab := NewIAB()
 func IABInit() *IAB {
 	return NewIAB()
 }