From 5965742e5fcde1ad65831436f836c86edfac7ab2 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Tue, 25 May 2021 14:16:12 +0200
Subject: [PATCH] Document DocumentSignatureType

---
 .../pgpainless/algorithm/DocumentSignatureType.java  | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/algorithm/DocumentSignatureType.java b/pgpainless-core/src/main/java/org/pgpainless/algorithm/DocumentSignatureType.java
index 20b3da38..09ec321d 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/algorithm/DocumentSignatureType.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/algorithm/DocumentSignatureType.java
@@ -15,10 +15,22 @@
  */
 package org.pgpainless.algorithm;
 
+/**
+ * Subset of {@link SignatureType}, used for signatures over documents.
+ */
 public enum DocumentSignatureType {
 
+    /**
+     * Signature is calculated over the unchanged binary data.
+     */
     BINARY_DOCUMENT(SignatureType.BINARY_DOCUMENT),
 
+    /**
+     * The signature is calculated over the text data with its line endings converted to
+     * <pre>
+     *     {@code &lt;CR&gt;&lt;LF&gt;}
+     * </pre>.
+     */
     CANONICAL_TEXT_DOCUMENT(SignatureType.CANONICAL_TEXT_DOCUMENT),
     ;