You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2021/07/26 07:21:14 UTC

[sling-org-apache-sling-commons-messaging-mail] 19/23: [checkstyle] (javadoc) MissingJavadocType

This is an automated email from the ASF dual-hosted git repository.

olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-messaging-mail.git

commit 3713f9c11b264961c0ba0429fd00b561bbdd8b93
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 24 21:44:38 2021 +0200

    [checkstyle] (javadoc) MissingJavadocType
---
 checkstyle-suppressions.xml                                          | 1 +
 .../java/org/apache/sling/commons/messaging/mail/MailService.java    | 5 +++++
 .../java/org/apache/sling/commons/messaging/mail/MessageBuilder.java | 5 +++++
 .../org/apache/sling/commons/messaging/mail/MessageIdProvider.java   | 5 +++++
 4 files changed, 16 insertions(+)

diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
index 5876e15..295d2af 100644
--- a/checkstyle-suppressions.xml
+++ b/checkstyle-suppressions.xml
@@ -19,6 +19,7 @@
 -->
 <!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
 <suppressions>
+  <suppress checks="MissingJavadocType" files=".*\/internal\/.*\.java"/>
   <suppress checks="ClassFanOutComplexity" files=".*\/SimpleMailService\.java"/>
   <suppress checks="ClassFanOutComplexity" files=".*\/SimpleMessageBuilder\.java"/>
   <suppress checks="ClassDataAbstractionCoupling" files=".*\/SimpleMessageBuilder\.java"/>
diff --git a/src/main/java/org/apache/sling/commons/messaging/mail/MailService.java b/src/main/java/org/apache/sling/commons/messaging/mail/MailService.java
index 0b1af4a..e1d176f 100644
--- a/src/main/java/org/apache/sling/commons/messaging/mail/MailService.java
+++ b/src/main/java/org/apache/sling/commons/messaging/mail/MailService.java
@@ -26,6 +26,11 @@ import org.apache.sling.commons.messaging.MessageService;
 import org.jetbrains.annotations.NotNull;
 import org.osgi.annotation.versioning.ProviderType;
 
+/**
+ * Service for sending MIME messages.
+ *
+ * @see MimeMessage
+ */
 @ProviderType
 public interface MailService extends MessageService<MimeMessage, Void> {
 
diff --git a/src/main/java/org/apache/sling/commons/messaging/mail/MessageBuilder.java b/src/main/java/org/apache/sling/commons/messaging/mail/MessageBuilder.java
index 52e926e..3534491 100644
--- a/src/main/java/org/apache/sling/commons/messaging/mail/MessageBuilder.java
+++ b/src/main/java/org/apache/sling/commons/messaging/mail/MessageBuilder.java
@@ -30,6 +30,11 @@ import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.osgi.annotation.versioning.ProviderType;
 
+/**
+ * Builder for MIME messages.
+ *
+ * @see MimeMessage
+ */
 @ProviderType
 public interface MessageBuilder {
 
diff --git a/src/main/java/org/apache/sling/commons/messaging/mail/MessageIdProvider.java b/src/main/java/org/apache/sling/commons/messaging/mail/MessageIdProvider.java
index 00259c2..1948677 100644
--- a/src/main/java/org/apache/sling/commons/messaging/mail/MessageIdProvider.java
+++ b/src/main/java/org/apache/sling/commons/messaging/mail/MessageIdProvider.java
@@ -24,6 +24,11 @@ import jakarta.mail.internet.MimeMessage;
 import org.jetbrains.annotations.NotNull;
 import org.osgi.annotation.versioning.ProviderType;
 
+/**
+ * Provider for message identifiers.
+ *
+ * @see MimeMessage
+ */
 @ProviderType
 public interface MessageIdProvider {