added JavaDoc

cryptomator · Oct 12, 2022 · 739490c · 739490c
1 parent 2d696b4
commit 739490c
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/pom.xml b/pom.xml
@@ -252,6 +252,8 @@
 					</execution>
 				</executions>
 				<configuration>
+					<release>9</release>
+					<sourcepath>${project.basedir}/src/main/java9:${project.build.sourceDirectory}</sourcepath>
 					<tags>
 						<!-- workaround for "unknown tag: implNote", see https://blog.codefx.org/java/new-javadoc-tags/#Maven  -->
 						<tag>

diff --git a/src/main/java9/module-info.java b/src/main/java9/module-info.java
@@ -1,3 +1,12 @@
+import org.cryptomator.cryptolib.api.CryptorProvider;
+
+/**
+ * This module provides the highlevel cryptographic API used by Cryptomator.
+ *
+ * @uses CryptorProvider See {@link CryptorProvider#forScheme(CryptorProvider.Scheme)}
+ * @provides CryptorProvider Providers for {@link org.cryptomator.cryptolib.api.CryptorProvider.Scheme#SIV_CTRMAC SIV/CTR-then-MAC}
+ * and {@link org.cryptomator.cryptolib.api.CryptorProvider.Scheme#SIV_GCM SIV/GCM}
+ */
 module org.cryptomator.cryptolib {
 	requires static org.bouncycastle.provider; // will be shaded
 	requires static org.bouncycastle.pkix; // will be shaded
@@ -12,8 +21,8 @@
 
 	opens org.cryptomator.cryptolib.common to com.google.gson;
 
-	uses org.cryptomator.cryptolib.api.CryptorProvider;
+	uses CryptorProvider;
 
-	provides org.cryptomator.cryptolib.api.CryptorProvider
+	provides CryptorProvider
 			with org.cryptomator.cryptolib.v1.CryptorProviderImpl, org.cryptomator.cryptolib.v2.CryptorProviderImpl;
 }