Skip to content

Commit 34d980c

Browse files
committed
fix doc comments formatting
1 parent 68c2fee commit 34d980c

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

pom.xml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,8 +335,18 @@
335335
<configuration>
336336
<configFile>${project.basedir}/hbase-formatter.xml</configFile>
337337
<directories>
338-
<directory>${project.basedir}/src/main/java/redis/clients/jedis/annots</directory>
338+
<directory>${project.basedir}</directory>
339339
</directories>
340+
<includes>
341+
<!-- Specific files -->
342+
<include>src/main/java/redis/clients/jedis/annots/*.java</include>
343+
<include>src/main/java/redis/clients/jedis/resps/StreamEntryDeletionResult.java</include>
344+
<include>src/main/java/redis/clients/jedisargs/StreamDeletionPolicy.java</include>
345+
<include>src/test/java/redis/clients/jedis/commands/StreamsCommandsTestBase.java</include>
346+
<include>src/test/java/redis/clients/jedis/commands/jedis/ClusterStreamsCommandsTest.java</include>
347+
<include>src/test/java/redis/clients/jedis/commands/jedis/PooledStreamsCommandsTest.java</include>
348+
<include>src/test/java/redis/clients/jedis/resps/StreamEntryDeletionResultTest.java</include>
349+
</includes>
340350
</configuration>
341351
<executions>
342352
<execution>

src/main/java/redis/clients/jedis/resps/StreamEntryDeletionResult.java

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
package redis.clients.jedis.resps;
22

33
/**
4-
* Represents the result of a stream entry deletion operation for XDELEX and XACKDEL commands. -
5-
* NOT_FOUND (-1): ID doesn't exist in stream - DELETED (1): Entry was deleted/acknowledged and
6-
* deleted - ACKNOWLEDGED_NOT_DELETED (2): Entry was acknowledged but not deleted (still has
7-
* dangling references)
4+
* Represents the result of a stream entry deletion operation for XDELEX and XACKDEL commands.
5+
* <ul>
6+
* <li>NOT_FOUND (-1): ID doesn't exist in stream</li>
7+
* <li>DELETED (1): Entry was deleted/acknowledged and deleted</li>
8+
* <li>ACKNOWLEDGED_NOT_DELETED (2): Entry was acknowledged but not deleted (still has dangling
9+
* references)</li>
10+
* </ul>
811
*/
912
public enum StreamEntryDeletionResult {
1013

1114
/**
12-
* The stream entry ID doesn't exist in the stream. Returned when trying to delete/acknowledge a
13-
* non-existent entry.
15+
* The stream entry ID doesn't exist in the stream.
16+
* <p>
17+
* Returned when trying to delete/acknowledge a non-existent entry.
18+
* </p>
1419
*/
1520
NOT_FOUND(-1),
1621

1722
/**
18-
* The entry was successfully deleted/acknowledged and deleted. This is the typical successful
19-
* case.
23+
* The entry was successfully deleted/acknowledged and deleted.
24+
* <p>
25+
* This is the typical successful case.
26+
* </p>
2027
*/
2128
DELETED(1),
2229

0 commit comments

Comments
 (0)