Document the purpose of the UserDataPacket interface

vanitasvitae · vanitasvitae · commit 0518ada54c19 · 2024-08-08T12:37:19.000+02:00
diff --git a/pg/src/main/java/org/bouncycastle/bcpg/UserDataPacket.java b/pg/src/main/java/org/bouncycastle/bcpg/UserDataPacket.java
@@ -1,5 +1,9 @@
 package org.bouncycastle.bcpg;
 
+/**
+ * Superclass for user identities ({@link UserIDPacket}, {@link UserAttributePacket}).
+ * The superclass is used to hold different user identity objects in the same collection.
+ */
 public interface UserDataPacket
 {
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,9 @@`
`1`	`1`	`package org.bouncycastle.bcpg;`
`2`	`2`
	`3`	`+/**`
	`4`	`+ * Superclass for user identities ({@link UserIDPacket}, {@link UserAttributePacket}).`
	`5`	`+ * The superclass is used to hold different user identity objects in the same collection.`
	`6`	`+ */`
`3`	`7`	`public interface UserDataPacket`
`4`	`8`	`{`
`5`	`9`