From 4785915537816aece872343b054bb5a420c2a699 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Mon, 18 Jan 2021 20:07:52 +0000 Subject: [PATCH] Add missing @return notes in javadoc (#3) --- src/main/java/net/kemitix/trello/TrelloConfig.java | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/main/java/net/kemitix/trello/TrelloConfig.java b/src/main/java/net/kemitix/trello/TrelloConfig.java index 1699df6..31c300a 100644 --- a/src/main/java/net/kemitix/trello/TrelloConfig.java +++ b/src/main/java/net/kemitix/trello/TrelloConfig.java @@ -6,6 +6,8 @@ public interface TrelloConfig { * The Trello Developer API Key. * *

https://trello.com/app-key

+ * + * @return The Trello Developer API Key */ String getTrelloKey(); @@ -13,16 +15,22 @@ public interface TrelloConfig { * The Trello Developer API Key Token. * *

https://trello.com/app-key

+ * + * @return The Trello Developer API Key Token */ String getTrelloSecret(); /** * The name of the user with access to the Trello Slush Pile Board. + * + * @return The Trello Username */ String getUserName(); /** * The trello board containing the Slush Pile. + * + * @return The Trello Board Name */ String getBoardName(); @@ -30,6 +38,8 @@ public interface TrelloConfig { * The email address to send submission attachments to. * *

e.g. the kindle address

+ * + * @return The Sender Email Address */ String getSender(); @@ -37,11 +47,15 @@ public interface TrelloConfig { * The email address to send emails from. * *

If sending to Kindle, then ensure this address is listed as a valid sender.

+ * + * @return The Reader Email address */ String getReader(); /** * The URL of the Webhook to register with services. + * + * @return The Webhook URL */ String getWebhook();