Document the purpose of the UserDataPacket interface

bcgit · Jul 18, 2024 · 81c9116 · 81c9116
1 parent fd07a8f
commit 81c9116
Showing 1 changed file with 4 additions and 0 deletions.
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
 {