From 0a3f688b2324e0fee2c61c943288610f13571ac1 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Fri, 10 Jul 2020 20:31:33 +0200
Subject: [PATCH] Add documentation for openpgp4fpr fingerprint methods

---
 .../org/pgpainless/key/OpenPgpV4Fingerprint.java | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/key/OpenPgpV4Fingerprint.java b/pgpainless-core/src/main/java/org/pgpainless/key/OpenPgpV4Fingerprint.java
index a4be8ec8..469f6068 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/key/OpenPgpV4Fingerprint.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/key/OpenPgpV4Fingerprint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 Paul Schaub.
+ * Copyright 2018-2020 Paul Schaub.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -142,6 +142,13 @@ public class OpenPgpV4Fingerprint implements CharSequence, Comparable<OpenPgpV4F
         return fingerprint;
     }
 
+    /**
+     * Return the fingerprint as an openpgp4fpr {@link URI}.
+     * An example would be 'openpgp4fpr:7F9116FEA90A5983936C7CFAA027DB2F3E1E118A'.
+     *
+     * @return openpgp4fpr fingerprint uri
+     * @see <a href="https://metacode.biz/openpgp/openpgp4fpr">openpgp4fpr URI scheme</a>
+     */
     public URI toUri() {
         try {
             return new URI(SCHEME, toString(), null);
@@ -150,6 +157,13 @@ public class OpenPgpV4Fingerprint implements CharSequence, Comparable<OpenPgpV4F
         }
     }
 
+    /**
+     * Convert a openpgp4fpr URI to an {@link OpenPgpV4Fingerprint}.
+     *
+     * @param uri {@link URI} with scheme 'openpgp4fpr'
+     * @return fingerprint parsed from the uri
+     * @see <a href="https://metacode.biz/openpgp/openpgp4fpr">openpgp4fpr URI scheme</a>
+     */
     public static OpenPgpV4Fingerprint fromUri(URI uri) {
         if (!SCHEME.equals(uri.getScheme())) {
             throw new IllegalArgumentException("URI scheme MUST equal '" + SCHEME + "'");