Add missing @return notes in javadoc (#3)
This commit is contained in:
parent
5999c33994
commit
4785915537
1 changed files with 14 additions and 0 deletions
|
@ -6,6 +6,8 @@ public interface TrelloConfig {
|
||||||
* The Trello Developer API Key.
|
* The Trello Developer API Key.
|
||||||
*
|
*
|
||||||
* <p>https://trello.com/app-key</p>
|
* <p>https://trello.com/app-key</p>
|
||||||
|
*
|
||||||
|
* @return The Trello Developer API Key
|
||||||
*/
|
*/
|
||||||
String getTrelloKey();
|
String getTrelloKey();
|
||||||
|
|
||||||
|
@ -13,16 +15,22 @@ public interface TrelloConfig {
|
||||||
* The Trello Developer API Key Token.
|
* The Trello Developer API Key Token.
|
||||||
*
|
*
|
||||||
* <p>https://trello.com/app-key</p>
|
* <p>https://trello.com/app-key</p>
|
||||||
|
*
|
||||||
|
* @return The Trello Developer API Key Token
|
||||||
*/
|
*/
|
||||||
String getTrelloSecret();
|
String getTrelloSecret();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The name of the user with access to the Trello Slush Pile Board.
|
* The name of the user with access to the Trello Slush Pile Board.
|
||||||
|
*
|
||||||
|
* @return The Trello Username
|
||||||
*/
|
*/
|
||||||
String getUserName();
|
String getUserName();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The trello board containing the Slush Pile.
|
* The trello board containing the Slush Pile.
|
||||||
|
*
|
||||||
|
* @return The Trello Board Name
|
||||||
*/
|
*/
|
||||||
String getBoardName();
|
String getBoardName();
|
||||||
|
|
||||||
|
@ -30,6 +38,8 @@ public interface TrelloConfig {
|
||||||
* The email address to send submission attachments to.
|
* The email address to send submission attachments to.
|
||||||
*
|
*
|
||||||
* <p>e.g. the kindle address</p>
|
* <p>e.g. the kindle address</p>
|
||||||
|
*
|
||||||
|
* @return The Sender Email Address
|
||||||
*/
|
*/
|
||||||
String getSender();
|
String getSender();
|
||||||
|
|
||||||
|
@ -37,11 +47,15 @@ public interface TrelloConfig {
|
||||||
* The email address to send emails from.
|
* The email address to send emails from.
|
||||||
*
|
*
|
||||||
* <p>If sending to Kindle, then ensure this address is listed as a valid sender.</p>
|
* <p>If sending to Kindle, then ensure this address is listed as a valid sender.</p>
|
||||||
|
*
|
||||||
|
* @return The Reader Email address
|
||||||
*/
|
*/
|
||||||
String getReader();
|
String getReader();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The URL of the Webhook to register with services.
|
* The URL of the Webhook to register with services.
|
||||||
|
*
|
||||||
|
* @return The Webhook URL
|
||||||
*/
|
*/
|
||||||
String getWebhook();
|
String getWebhook();
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue