diff --git a/PlayWallCore/src/main/java/de/tobias/playpad/PlayPad.java b/PlayWallCore/src/main/java/de/tobias/playpad/PlayPad.java index 64506fc1abff045fb02b7457ddbaa9a92e7c0172..14d50ffae9ec046ee3cdb1b70fa00542ec112b81 100644 --- a/PlayWallCore/src/main/java/de/tobias/playpad/PlayPad.java +++ b/PlayWallCore/src/main/java/de/tobias/playpad/PlayPad.java @@ -9,6 +9,7 @@ import de.tobias.playpad.plugin.SettingsListener; import de.tobias.playpad.profile.ProfileNotFoundException; import de.tobias.playpad.project.Project; import de.tobias.playpad.project.ProjectNotFoundException; +import de.tobias.playpad.project.ProjectReader; import de.tobias.playpad.project.ProjectReader.ProjectReaderDelegate.ProfileAbortException; import de.tobias.playpad.project.ref.ProjectReference; import de.tobias.playpad.settings.GlobalSettings; @@ -125,8 +126,13 @@ public interface PlayPad { /** * Open a project * - * @param projectReference project reference - * @param onLoaded on project loaded callback + * @param projectReference project reference + * @param onLoaded on project loaded callback + * @throws IOException io error + * @throws ProjectNotFoundException Project to solve error not found + * @throws ProfileNotFoundException Profile of project not found + * @throws DocumentException XML Error + * @throws ProjectReader.ProjectReaderDelegate.ProfileAbortException Profile Choose aborted */ void openProject(ProjectReference projectReference, Consumer<NVC> onLoaded) throws ProjectNotFoundException, ProfileAbortException, ProfileNotFoundException, DocumentException, IOException; diff --git a/PlayWallCore/src/main/java/de/tobias/playpad/action/feedback/ActionFeedbackSuggester.java b/PlayWallCore/src/main/java/de/tobias/playpad/action/feedback/ActionFeedbackSuggester.java index 93710a1a757de46ae5608f12c54e8140eec572fd..f6ed9f63c71266ee9ac858c3963fc32158adc01b 100644 --- a/PlayWallCore/src/main/java/de/tobias/playpad/action/feedback/ActionFeedbackSuggester.java +++ b/PlayWallCore/src/main/java/de/tobias/playpad/action/feedback/ActionFeedbackSuggester.java @@ -15,6 +15,7 @@ public interface ActionFeedbackSuggester { /** * Is automatic feedback suggestion enabled * + * @param action action * @return <code>true</code> Active */ boolean isAutoFeedbackColors(Action action); diff --git a/PlayWallCore/src/main/java/de/tobias/playpad/pad/Pad.java b/PlayWallCore/src/main/java/de/tobias/playpad/pad/Pad.java index 0cb34b30e4cb88645fdb2772e42d14bd7879be28..813e6792449f2015766119784717aa08b7ca7e04 100644 --- a/PlayWallCore/src/main/java/de/tobias/playpad/pad/Pad.java +++ b/PlayWallCore/src/main/java/de/tobias/playpad/pad/Pad.java @@ -687,7 +687,7 @@ public class Pad { /** * Returns true, when pad has content and pad is visible. * - * @return loaded & visible + * @return loaded & visible */ public boolean hasVisibleContent() { return getContent() != null && getContent().isPadLoaded() && isPadVisible(); diff --git a/PlayWallCore/src/main/java/de/tobias/playpad/project/page/Page.java b/PlayWallCore/src/main/java/de/tobias/playpad/project/page/Page.java index 9a15f3b463b80395fb52d4840ed792595d49978b..36d9b1d04b488322ad2d1449ca2025ea244e268b 100644 --- a/PlayWallCore/src/main/java/de/tobias/playpad/project/page/Page.java +++ b/PlayWallCore/src/main/java/de/tobias/playpad/project/page/Page.java @@ -229,7 +229,8 @@ public class Page { /** * Removes a pad from a page and from the cloud. * - * @param uuid id of the pad + * @param uuid id of the pad + * @param deleteRemote <code>true</code> delete from remote */ public void removePad(UUID uuid, boolean deleteRemote) { if (projectReference.getProjectReference().isSync() && deleteRemote) { diff --git a/PlayWallCore/src/main/java/de/tobias/playpad/server/Server.java b/PlayWallCore/src/main/java/de/tobias/playpad/server/Server.java index 16ea6b42364d7b1149f26debfdd9dd3137957466..0b71f4248eba6110c1ce64a6137ddd9e891577ce 100644 --- a/PlayWallCore/src/main/java/de/tobias/playpad/server/Server.java +++ b/PlayWallCore/src/main/java/de/tobias/playpad/server/Server.java @@ -59,6 +59,8 @@ public interface Server { * @param username username * @param password password * @return session key + * @throws IOException server communication error + * @throws LoginException login error */ String getSession(String username, String password) throws IOException, LoginException; @@ -68,7 +70,8 @@ public interface Server { * Get a list of the synced projects. * * @return synced projects - * @throws IOException notwork error + * @throws IOException notwork error + * @throws LoginException login error */ List<ProjectReference> getSyncedProjects() throws IOException, LoginException; @@ -94,6 +97,7 @@ public interface Server { * * @param projectReference project reference * @return last modification + * @throws IOException server communication error */ Version getLastServerModification(ProjectReference projectReference) throws IOException; @@ -101,6 +105,8 @@ public interface Server { * Connect to sync server with key. * * @param key auth key + * @throws IOException server communication error + * @throws WebSocketException error creating websocket connection */ void connect(String key) throws IOException, WebSocketException; diff --git a/PlayWallCore/src/main/java/de/tobias/playpad/server/sync/command/Command.java b/PlayWallCore/src/main/java/de/tobias/playpad/server/sync/command/Command.java index ea76d4f7369a23d43e1334157abca2b298ebeb8e..7faab034a53d6d878a66a3666315ae6eb81bc311 100644 --- a/PlayWallCore/src/main/java/de/tobias/playpad/server/sync/command/Command.java +++ b/PlayWallCore/src/main/java/de/tobias/playpad/server/sync/command/Command.java @@ -11,6 +11,7 @@ public interface Command { * Execute a command. * * @param data optional data parameter + * @return response to communication peer */ JsonObject execute(Object data); } diff --git a/PlayWallCore/src/main/java/de/tobias/playpad/server/sync/conflict/ConflictSolver.java b/PlayWallCore/src/main/java/de/tobias/playpad/server/sync/conflict/ConflictSolver.java index 4055ca2c7eb7fda22806f2167bf85187322956fb..e01c73a8fe4e1b4ae696146cb1581bb7cab5bc1c 100644 --- a/PlayWallCore/src/main/java/de/tobias/playpad/server/sync/conflict/ConflictSolver.java +++ b/PlayWallCore/src/main/java/de/tobias/playpad/server/sync/conflict/ConflictSolver.java @@ -21,6 +21,11 @@ public interface ConflictSolver { * @param executor command executor * @param project project * @param type strategy type + * @throws IOException server communication error + * @throws ProjectNotFoundException Project to solve error not found + * @throws ProfileNotFoundException Profile of project not found + * @throws DocumentException XML Error + * @throws ProjectReader.ProjectReaderDelegate.ProfileAbortException Profile Choose aborted */ void solveConflict(CommandExecutor executor, ProjectReference project, ConflictStrategyType type) throws ProjectNotFoundException, ProfileNotFoundException, DocumentException, IOException, ProjectReader.ProjectReaderDelegate.ProfileAbortException; @@ -30,6 +35,7 @@ public interface ConflictSolver { * @param executor command executor * @param reference project reference * @return conflict type + * @throws IOException server communication error */ ConflictType checkConflict(CommandExecutor executor, ProjectReference reference) throws IOException; @@ -38,6 +44,7 @@ public interface ConflictSolver { * * @param reference project reference * @return list of versions + * @throws IOException server communication error */ List<Version> getVersions(ProjectReference reference) throws IOException; }