Merge pull request #25 from mailersend/javadoc

fixes for javadocs
mailersend · Apr 21, 2022 · b6fe71e · b6fe71e
2 parents 6ae08cf + c0cd9fb
commit b6fe71e
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 12 deletions.
diff --git a/pom.xml b/pom.xml
@@ -64,7 +64,7 @@
 			<plugin>
 			    <groupId>org.apache.maven.plugins</groupId>
 			    <artifactId>maven-javadoc-plugin</artifactId>
-			    <version>2.9.1</version>
+			    <version>3.0.1</version>
 			    <executions>
 			      <execution>
 				<id>attach-javadocs</id>

diff --git a/src/main/java/com/mailersend/sdk/analytics/Analytics.java b/src/main/java/com/mailersend/sdk/analytics/Analytics.java
@@ -31,7 +31,7 @@ public class Analytics {
 
     /**
      * Do not initialize directly. This should only be accessed from MailerSend.analytics
-     * @param apiReference
+     * @param ref
      */
     public Analytics(MailerSend ref) {
 

diff --git a/src/main/java/com/mailersend/sdk/domains/Domains.java b/src/main/java/com/mailersend/sdk/domains/Domains.java
@@ -29,7 +29,7 @@ public class Domains {
 
     /**
      * Do not initialize directly. This should only be accessed from MailerSend.domains
-     * @param apiReference
+     * @param ref
      */
     public Domains(MailerSend ref) {
 

diff --git a/src/main/java/com/mailersend/sdk/emails/Emails.java b/src/main/java/com/mailersend/sdk/emails/Emails.java
@@ -65,7 +65,7 @@ public Email createEmail() {
     /**
      * Sends the given email
      * @param email
-     * @throws MailerSendResponseError 
+     * @throws MailerSendException 
      */
     public MailerSendResponse send(Email email) throws MailerSendException {
 

diff --git a/src/main/java/com/mailersend/sdk/emails/Variable.java b/src/main/java/com/mailersend/sdk/emails/Variable.java
@@ -22,8 +22,7 @@ public class Variable {
 
     /**
      * Adds or replaces a variable substitution
-     * @param variable
-     * @param value
+     * @param substitution
      */
     public void addSubstitution(Substitution substitution) {
 

diff --git a/src/main/java/com/mailersend/sdk/recipients/Recipients.java b/src/main/java/com/mailersend/sdk/recipients/Recipients.java
@@ -30,7 +30,7 @@ public class Recipients {
 
     /**
      * Do not initialize directly. This should only be accessed from MailerSend.analytics
-     * @param apiReference
+     * @param ref
      */
     public Recipients(MailerSend ref) {
 

diff --git a/src/main/java/com/mailersend/sdk/recipients/Suppressions.java b/src/main/java/com/mailersend/sdk/recipients/Suppressions.java
@@ -30,7 +30,7 @@ public class Suppressions {
 
     /**
      * Do not initialize directly. This should only be accessed from MailerSend.analytics
-     * @param apiReference
+     * @param ref
      */
     public Suppressions(MailerSend ref) {
 

diff --git a/src/main/java/com/mailersend/sdk/templates/Templates.java b/src/main/java/com/mailersend/sdk/templates/Templates.java
@@ -25,7 +25,7 @@ public class Templates {
 
     /**
      * Do not initialize directly. This should only be accessed from MailerSend.analytics
-     * @param apiReference
+     * @param ref
      */
     public Templates(MailerSend ref) {
 

diff --git a/src/main/java/com/mailersend/sdk/webhooks/Webhooks.java b/src/main/java/com/mailersend/sdk/webhooks/Webhooks.java
@@ -26,7 +26,7 @@ public class Webhooks {
 
     /**
      * Do not initialize directly. This should only be accessed from MailerSend.webhooks
-     * @param apiReference
+     * @param apiObjectRef
      */
     public Webhooks(MailerSend apiObjectRef) {
 
@@ -92,7 +92,7 @@ public WebhooksList getWebhooks(String domainId) throws MailerSendException {
 
     /**
      * Gets a single webhook
-     * @param domainId
+     * @param webhookId
      * @return
      * @throws MailerSendException
      */

diff --git a/src/main/java/com/mailersend/sdk/webhooks/WebhooksBuilder.java b/src/main/java/com/mailersend/sdk/webhooks/WebhooksBuilder.java
@@ -141,7 +141,7 @@ public Webhook createWebhook(String domainId) throws MailerSendException {
 
     /**
      * Updates the webhook with the given id
-     * @param domainId
+     * @param webhookId
      * @return
      * @throws MailerSendException
      */