Skip to content

Commit 0db22cc

Browse files
authored
Remove redundant paragraph tags in JavaDoc comments. (#42)
1 parent 3d54064 commit 0db22cc

File tree

12 files changed

+60
-60
lines changed

12 files changed

+60
-60
lines changed

assertj-mail/src/main/java/org/devopsix/assertj/mail/AbstractPartAssert.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ protected AbstractPartAssert(A part, Class<? extends AbstractPartAssert<S, A>> s
2121
}
2222

2323
/**
24-
* <p>Returns a {@code String} assertion for the message part's header with the given name.</p>
24+
* Returns a {@code String} assertion for the message part's header with the given name.
2525
*
2626
* @param name Header name
2727
* @return An assertion for the message part's given header
@@ -32,8 +32,8 @@ public AbstractCharSequenceAssert<?, String> headerValue(String name) {
3232
}
3333

3434
/**
35-
* <p>Returns a {@code String} array assertion for the message part's header with the given
36-
* name.</p>
35+
* Returns a {@code String} array assertion for the message part's header with the given
36+
* name.
3737
*
3838
* @param name Header name
3939
* @return An assertion for the message part's given header
@@ -43,8 +43,8 @@ public AbstractObjectArrayAssert<?, String> headerValues(String name) {
4343
}
4444

4545
/**
46-
* <p>Returns a {@code OffsetDateTime} assertion for the message part's header with the given
47-
* name.</p>
46+
* Returns a {@code OffsetDateTime} assertion for the message part's header with the given
47+
* name.
4848
*
4949
* @param name Header name
5050
* @return An assertion for the message part's given header
@@ -56,8 +56,8 @@ public AbstractOffsetDateTimeAssert<?> dateHeaderValue(String name) {
5656
}
5757

5858
/**
59-
* <p>Returns a {@code OffsetDateTime} array assertion for the message part's header with the
60-
* given name.</p>
59+
* Returns a {@code OffsetDateTime} array assertion for the message part's header with the
60+
* given name.
6161
*
6262
* @param name Header name
6363
* @return An assertion for the message part's given header
@@ -68,7 +68,7 @@ public AbstractObjectArrayAssert<?, OffsetDateTime> dateHeaderValues(String name
6868
}
6969

7070
/**
71-
* <p>Returns a {@code String} assertion for the message part's plain text content.</p>
71+
* Returns a {@code String} assertion for the message part's plain text content.
7272
*
7373
* @return An assertion for the message part's text content
7474
* @throws AssertionError If the content is not plain text or reading it fails
@@ -78,7 +78,7 @@ public AbstractCharSequenceAssert<?, String> textContent() {
7878
}
7979

8080
/**
81-
* <p>Returns a {@code byte[]} assertion for the message part's binary content.</p>
81+
* Returns a {@code byte[]} assertion for the message part's binary content.
8282
*
8383
* @return An assertion for the message part's binary content
8484
* @throws AssertionError If the content is not binary content or reading it fails
@@ -88,7 +88,7 @@ public AbstractByteArrayAssert<?> binaryContent() {
8888
}
8989

9090
/**
91-
* <p>Asserts that the message part has multipart content ({@code Content-Type: multipart/*}).</p>
91+
* Asserts that the message part has multipart content ({@code Content-Type: multipart/*}).
9292
*
9393
* @return The original assertion for further chaining
9494
* @throws AssertionError If the content is not multipart content or reading it fails
@@ -101,8 +101,8 @@ public S isMultipart() {
101101
}
102102

103103
/**
104-
* <p>Returns a {@code Multipart} assertion for the message part's multipart content
105-
* ({@code Content-Type: multipart/*}).</p>
104+
* Returns a {@code Multipart} assertion for the message part's multipart content
105+
* ({@code Content-Type: multipart/*}).
106106
*
107107
* @return An assertion for the message part's multipart content
108108
* @throws AssertionError If the content is not multipart content or reading it fails
@@ -112,8 +112,8 @@ public MultipartAssert multipartContent() {
112112
}
113113

114114
/**
115-
* <p>Returns a {@code Multipart} array assertion for all the message part's multipart contents
116-
* ({@code Content-Type: multipart/*}). Multipart contents are searched recursively.</p>
115+
* Returns a {@code Multipart} array assertion for all the message part's multipart contents
116+
* ({@code Content-Type: multipart/*}). Multipart contents are searched recursively.
117117
*
118118
* <p>Please note that no assertion error occurs if the message part is not of multipart type.
119119
* The returned assertion contains an empty array in this case.</p>

assertj-mail/src/main/java/org/devopsix/assertj/mail/DkimSignatureAssert.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ private DkimSignatureAssert(Part message, Map<String, String> publicKeys) {
3434
}
3535

3636
/**
37-
* <p>Creates a new instance.</p>
37+
* Creates a new instance.
3838
*
3939
* @param message Assertion subject
4040
* @param publicKeys Map of public keys as they would be published in DNS TXT records
@@ -45,7 +45,7 @@ public static DkimSignatureAssert assertThat(Part message, Map<String, String> p
4545
}
4646

4747
/**
48-
* <p>Asserts that the DKIM signature is valid.</p>
48+
* Asserts that the DKIM signature is valid.
4949
*
5050
* @return The original assertion for further chaining
5151
* @throws AssertionError If the DKIM signature is not valid
@@ -63,7 +63,7 @@ public DkimSignatureAssert isValid() {
6363
}
6464

6565
/**
66-
* <p>Returns a {@code SignatureRecord} array assertion for the signature's records.</p>
66+
* Returns a {@code SignatureRecord} array assertion for the signature's records.
6767
*
6868
* @return An assertion for the DKIM signature's records
6969
* @throws AssertionError If validating the signature fails

assertj-mail/src/main/java/org/devopsix/assertj/mail/InternetAddressAssert.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public final class InternetAddressAssert
1313
extends AbstractAssert<InternetAddressAssert, InternetAddress> {
1414

1515
/**
16-
* <p>Creates a new instance.</p>
16+
* Creates a new instance.
1717
*
1818
* @param internetAddress Assertion subject
1919
*/
@@ -22,8 +22,8 @@ public InternetAddressAssert(InternetAddress internetAddress) {
2222
}
2323

2424
/**
25-
* <p>Returns a {@code String} assertion for the internet address' actual address part.
26-
* I.e. “[email protected]” in {@code "Anna <[email protected]>"}</p>
25+
* Returns a {@code String} assertion for the internet address' actual address part.
26+
* I.e. “[email protected]” in {@code "Anna <[email protected]>"}
2727
*
2828
* @return An assertion for the address part
2929
*/
@@ -32,8 +32,8 @@ public AbstractCharSequenceAssert<?, String> address() {
3232
}
3333

3434
/**
35-
* <p>Returns a {@code String} assertion for the internet address' personal name part.
36-
* I.e. “Anna” in {@code "Anna <[email protected]>"}.</p>
35+
* Returns a {@code String} assertion for the internet address' personal name part.
36+
* I.e. “Anna” in {@code "Anna <[email protected]>"}.
3737
*
3838
* @return An assertion for the name part
3939
*/

assertj-mail/src/main/java/org/devopsix/assertj/mail/MailAssertions.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,39 @@
88
import org.assertj.core.api.InstanceOfAssertFactory;
99

1010
/**
11-
* <p>This class provides access to all AssertJ Mail assertions.</p>
11+
* This class provides access to all AssertJ Mail assertions.
1212
*/
1313
public final class MailAssertions {
1414

1515
private MailAssertions() {
1616
}
1717

1818
/**
19-
* <p>A factory for creating instances of {@link MessageAssert}.</p>
19+
* A factory for creating instances of {@link MessageAssert}.
2020
*
2121
* @see Assertions#as(InstanceOfAssertFactory)
2222
*/
2323
public static final InstanceOfAssertFactory<Message, MessageAssert> MESSAGE =
2424
new InstanceOfAssertFactory<>(Message.class, MailAssertions::assertThat);
2525

2626
/**
27-
* <p>A factory for creating instances of {@link PartAssert}.</p>
27+
* A factory for creating instances of {@link PartAssert}.
2828
*
2929
* @see Assertions#as(InstanceOfAssertFactory)
3030
*/
3131
public static final InstanceOfAssertFactory<Part, PartAssert> PART =
3232
new InstanceOfAssertFactory<>(Part.class, MailAssertions::assertThat);
3333

3434
/**
35-
* <p>A factory for creating instances of {@link MultipartAssert}.</p>
35+
* A factory for creating instances of {@link MultipartAssert}.
3636
*
3737
* @see Assertions#as(InstanceOfAssertFactory)
3838
*/
3939
public static final InstanceOfAssertFactory<Multipart, MultipartAssert> MULTIPART =
4040
new InstanceOfAssertFactory<>(Multipart.class, MailAssertions::assertThat);
4141

4242
/**
43-
* <p>A factory for creating instances of {@link InternetAddressAssert}.</p>
43+
* A factory for creating instances of {@link InternetAddressAssert}.
4444
*
4545
* @see Assertions#as(InstanceOfAssertFactory)
4646
*/
@@ -49,8 +49,8 @@ private MailAssertions() {
4949
new InstanceOfAssertFactory<>(InternetAddress.class, MailAssertions::assertThat);
5050

5151
/**
52-
* <p>Returns an instance of {@code MessageAssert} which can be used to verify assertions
53-
* for the given message.</p>
52+
* Returns an instance of {@code MessageAssert} which can be used to verify assertions
53+
* for the given message.
5454
*
5555
* @param message The message to assert
5656
* @return An instance of {@code MessageAssert} for the given message
@@ -60,8 +60,8 @@ public static MessageAssert assertThat(Message message) {
6060
}
6161

6262
/**
63-
* <p>Returns an instance of {@code PartAssert} which can be used to verify assertions
64-
* for the given message part.</p>
63+
* Returns an instance of {@code PartAssert} which can be used to verify assertions
64+
* for the given message part.
6565
*
6666
* @param part The message part to assert
6767
* @return An instance of {@code PartAssert} for the given message
@@ -71,8 +71,8 @@ public static PartAssert assertThat(Part part) {
7171
}
7272

7373
/**
74-
* <p>Returns an instance of {@code MultipartAssert} which can be used to verify assertions
75-
* for the given multipart.</p>
74+
* Returns an instance of {@code MultipartAssert} which can be used to verify assertions
75+
* for the given multipart.
7676
*
7777
* @param multipart The multipart to assert
7878
* @return An instance of {@code MultipartAssert} for the given multipart
@@ -82,8 +82,8 @@ public static MultipartAssert assertThat(Multipart multipart) {
8282
}
8383

8484
/**
85-
* <p>Returns an instance of {@code InternetAddressAssert} which can be used to verify assertions
86-
* for the given internet address.</p>
85+
* Returns an instance of {@code InternetAddressAssert} which can be used to verify assertions
86+
* for the given internet address.
8787
*
8888
* @param address The internet address to assert
8989
* @return An instance of {@code InternetAddressAssert} for the given message

assertj-mail/src/main/java/org/devopsix/assertj/mail/MailDateTimeFormatter.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
import java.util.regex.Pattern;
2222

2323
/**
24-
* <p>This class supplies a date time formatter relaxed enough to read both,
25-
* RFC 822 (two-digit year) and RFC 2822/1123 (four-digit year) notation.</p>
24+
* This class supplies a date time formatter relaxed enough to read both,
25+
* RFC 822 (two-digit year) and RFC 2822/1123 (four-digit year) notation.
2626
*
2727
* @author devopsix
2828
*/
@@ -94,7 +94,7 @@ private static Map<Long, String> monthNames() {
9494
private static final Pattern TRAILING_ZONE = compile("\\s+\\([^(]+\\)\\s*$");
9595

9696
/**
97-
* <p>Trims trailing time zone name in parentheses after the zone offset.</p>
97+
* Trims trailing time zone name in parentheses after the zone offset.
9898
*
9999
* <p>Some mailer programs seem to append the zone name although that is not covered by the
100100
* RFCs.</p>

assertj-mail/src/main/java/org/devopsix/assertj/mail/MessageAssert.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
public final class MessageAssert extends AbstractPartAssert<MessageAssert, Message> {
2525

2626
/**
27-
* <p>Creates a new instance.</p>
27+
* Creates a new instance.
2828
*
2929
* @param message Assertion subject
3030
*/
@@ -33,7 +33,7 @@ public MessageAssert(Message message) {
3333
}
3434

3535
/**
36-
* <p>Returns a {@code OffsetDateTime} assertion for the message's “Date” header.</p>
36+
* Returns a {@code OffsetDateTime} assertion for the message's “Date” header.
3737
*
3838
* @return An assertion for the message's “Date” header
3939
* @throws AssertionError If there is more than one “Date” header or parsing the header value
@@ -44,7 +44,7 @@ public AbstractOffsetDateTimeAssert<?> date() {
4444
}
4545

4646
/**
47-
* <p>Returns an {@code InternetAddress} array assertion for the message's “From” header.</p>
47+
* Returns an {@code InternetAddress} array assertion for the message's “From” header.
4848
*
4949
* @return An assertion for the message's “From” header
5050
* @throws AssertionError If there is more than one “From” header or parsing the header value
@@ -55,7 +55,7 @@ public AbstractObjectArrayAssert<?, InternetAddress> from() {
5555
}
5656

5757
/**
58-
* <p>Returns an {@code InternetAddress} assertion for the message's “Sender” header.</p>
58+
* Returns an {@code InternetAddress} assertion for the message's “Sender” header.
5959
*
6060
* @return An assertion for the message's “Sender” header
6161
* @throws AssertionError If there is more than one “Sender” header or parsing the header value
@@ -66,7 +66,7 @@ public InternetAddressAssert sender() {
6666
}
6767

6868
/**
69-
* <p>Returns an {@code InternetAddress} array assertion for the message's “Reply-To” header.</p>
69+
* Returns an {@code InternetAddress} array assertion for the message's “Reply-To” header.
7070
*
7171
* @return An assertion for the message's “Reply-To” header
7272
* @throws AssertionError If there is more than one “Reply-To” header or parsing the header value
@@ -77,7 +77,7 @@ public AbstractObjectArrayAssert<?, InternetAddress> replyTo() {
7777
}
7878

7979
/**
80-
* <p>Returns an {@code InternetAddress} array assertion for the message's “To” header.</p>
80+
* Returns an {@code InternetAddress} array assertion for the message's “To” header.
8181
*
8282
* @return An assertion for the message's “To” header
8383
* @throws AssertionError If there is more than one “To” header or parsing the header value fails
@@ -87,7 +87,7 @@ public AbstractObjectArrayAssert<?, InternetAddress> to() {
8787
}
8888

8989
/**
90-
* <p>Returns an {@code InternetAddress} array assertion for the message's “Cc” header.</p>
90+
* Returns an {@code InternetAddress} array assertion for the message's “Cc” header.
9191
*
9292
* @return An assertion for the message's “Cc” header
9393
* @throws AssertionError If there is more than one “Cc” header or parsing the header value fails
@@ -97,7 +97,7 @@ public AbstractObjectArrayAssert<?, InternetAddress> cc() {
9797
}
9898

9999
/**
100-
* <p>Returns an {@code InternetAddress} array assertion for the message's “Bcc” header.</p>
100+
* Returns an {@code InternetAddress} array assertion for the message's “Bcc” header.
101101
*
102102
* @return An assertion for the message's “Bcc” header
103103
* @throws AssertionError If there is more than one “Bcc” header or parsing the header value fails
@@ -107,7 +107,7 @@ public AbstractObjectArrayAssert<?, InternetAddress> bcc() {
107107
}
108108

109109
/**
110-
* <p>Returns a {@code String} assertion for the message's “Subject” header.</p>
110+
* Returns a {@code String} assertion for the message's “Subject” header.
111111
*
112112
* @return An assertion for the message's “Subject” header
113113
* @throws AssertionError If there is more than one “Subject” header
@@ -117,7 +117,7 @@ public AbstractCharSequenceAssert<?, String> subject() {
117117
}
118118

119119
/**
120-
* <p>Returns a {@code DkimSignatureAssert} assertion for the message's DKIM signature.</p>
120+
* Returns a {@code DkimSignatureAssert} assertion for the message's DKIM signature.
121121
*
122122
* <p>DKIM public keys are distributed as DNS TXT records. As tests should not depend
123123
* on any real DNS records this method accepts a map of virtual TXT records. The map keys

assertj-mail/src/main/java/org/devopsix/assertj/mail/MultipartAssert.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public final class MultipartAssert extends AbstractAssert<MultipartAssert, Multi
1515
private final MultipartReader multipartReader;
1616

1717
/**
18-
* <p>Creates a new instance.</p>
18+
* Creates a new instance.
1919
*
2020
* @param multipart Assertion subject
2121
*/
@@ -25,7 +25,7 @@ public MultipartAssert(Multipart multipart) {
2525
}
2626

2727
/**
28-
* <p>Returns a {@code String} assertion for the multipart's content type.</p>
28+
* Returns a {@code String} assertion for the multipart's content type.
2929
*
3030
* @return An assertion for the multipart's content type
3131
*/
@@ -34,7 +34,7 @@ public AbstractCharSequenceAssert<?, String> contentType() {
3434
}
3535

3636
/**
37-
* <p>Returns an {@code BodyPart} array assertion for the multipart's parts.</p>
37+
* Returns an {@code BodyPart} array assertion for the multipart's parts.
3838
*
3939
* @return An assertion for the multipart's parts
4040
* @throws AssertionError If reading the parts fails

assertj-mail/src/main/java/org/devopsix/assertj/mail/PartAssert.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
public final class PartAssert extends AbstractPartAssert<PartAssert, Part> {
99

1010
/**
11-
* <p>Creates a new instance.</p>
11+
* Creates a new instance.
1212
*
1313
* @param part Assertion subject
1414
*/

examples-jakarta/src/test/java/examples/GreenMailExampleTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
import static org.assertj.core.api.Assertions.as;
2121

2222
/**
23-
* <p>This class demonstrates how the AssertJ Mail assertions can be used together
24-
* with GreenMail for verifying an email sent by an application.</p>
23+
* This class demonstrates how the AssertJ Mail assertions can be used together
24+
* with GreenMail for verifying an email sent by an application.
2525
*
2626
* <p><a href="https://greenmail-mail-test.github.io/greenmail/">GreenMail</a> is an email server for testing purposes.</p>
2727
*

0 commit comments

Comments
 (0)