From 886753221029ac0135b99f98f9c360904d65e65f Mon Sep 17 00:00:00 2001 From: Armin Schrenk Date: Thu, 21 Jan 2021 12:42:00 +0100 Subject: [PATCH] add javadoc --- .../main/java/org/cryptomator/common/vaults/Volume.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/main/commons/src/main/java/org/cryptomator/common/vaults/Volume.java b/main/commons/src/main/java/org/cryptomator/common/vaults/Volume.java index 644cd9ac1..bf59423b4 100644 --- a/main/commons/src/main/java/org/cryptomator/common/vaults/Volume.java +++ b/main/commons/src/main/java/org/cryptomator/common/vaults/Volume.java @@ -35,8 +35,11 @@ public interface Volume { void mount(CryptoFileSystem fs, String mountFlags) throws IOException, VolumeException, InvalidMountPointException; /** - * TODO: refactor, such that this method accepts a (new) interface revealer and document that it could be ignored. + * Reveals the mounted volume. + *

+ * The given {@code revealer} might be used to do it, but not necessarily. * + * @param revealer An object capable of revealing the location of the mounted vault to view the content (e.g. in the default file browser). * @throws VolumeException */ void reveal(RevealerFacade revealer) throws VolumeException; @@ -84,6 +87,9 @@ public interface Volume { } + /** + * Hides and unifies the different Revealer implementations in the different nio-adapters. + */ @FunctionalInterface interface RevealerFacade {