Skip to content

Commit 4718a42

Browse files
committed
Documentation fixes
1 parent d347be6 commit 4718a42

File tree

2 files changed

+17
-24
lines changed

2 files changed

+17
-24
lines changed

java8/src/main/java/org/jetbrains/annotations/BlockingExecutor.java

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,13 @@
2020

2121
/**
2222
* Indicates that the annotated executor (CoroutineContext, Scheduler)
23-
* allows blocking methods execution.<br><br>
24-
* <p>
25-
* If a given executor does not allow blocking calls, {@link NonBlockingExecutor} should be used.<br><br>
23+
* allows blocking methods execution.
2624
* <p>
25+
* If a given executor does not allow blocking calls, {@link NonBlockingExecutor} should be used.
2726
*
27+
* <p>
2828
* Example 1 (Kotlin coroutines):
29-
* <pre>
30-
* {@code
29+
* <pre>{@code
3130
* class BlockingExampleService {
3231
* val dispatcher: @BlockingExecutor CoroutineContext
3332
* get() { ... }
@@ -40,12 +39,11 @@
4039
*
4140
* @Blocking fun blockingBuzz() { ... }
4241
* }
43-
* }
44-
* </pre><br>
42+
* }</pre>
43+
*
4544
* <p>
4645
* Example 2 (Java with Reactor framework):
47-
* <pre>
48-
* {@code
46+
* <pre>{@code
4947
* class BlockingExampleService {
5048
* private static final @BlockingExecutor Scheduler blockingScheduler =
5149
* Schedulers.newBoundedElastic(4, 10, "executor");
@@ -58,9 +56,8 @@
5856
* @Blocking
5957
* private String blockingBuzz(String url) { ... }
6058
* }
61-
* }
62-
* </pre>
63-
* <p>
59+
* }</pre>
60+
*
6461
* @see Blocking
6562
* @see NonBlocking
6663
*/

java8/src/main/java/org/jetbrains/annotations/NonBlockingExecutor.java

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,14 @@
2020

2121
/**
2222
* Indicates that the annotated executor (CoroutineContext, Scheduler)
23-
* does not allow blocking methods execution.<br><br>
24-
* <p>
23+
* does not allow blocking methods execution.
2524
*
26-
* If a given executor allows blocking calls, {@link BlockingExecutor} should be used.<br><br>
2725
* <p>
26+
* If a given executor allows blocking calls, {@link BlockingExecutor} should be used.
2827
*
28+
* <p>
2929
* Example 1 (Kotlin coroutines):
30-
* <pre>
31-
* {@code
30+
* <pre>{@code
3231
* class NonBlockingExampleService {
3332
* val dispatcher: @NonBlockingExecutor CoroutineContext
3433
* get() { ... }
@@ -41,12 +40,11 @@
4140
*
4241
* @Blocking fun blockingBuzz() { ... }
4342
* }
44-
* }
45-
* </pre><br>
43+
* }</pre>
44+
*
4645
* <p>
4746
* Example 2 (Java with Reactor framework):
48-
* <pre>
49-
* {@code
47+
* <pre>{@code
5048
* class NonBlockingExampleService {
5149
* private static final @NonBlockingExecutor Scheduler operationsScheduler =
5250
* Schedulers.newParallel("parallel");
@@ -59,9 +57,7 @@
5957
* @Blocking
6058
* private String blockingBuzz(String url) { ... }
6159
* }
62-
* }
63-
* </pre>
64-
* <p>
60+
* }</pre>
6561
* @see Blocking
6662
* @see NonBlocking
6763
*/

0 commit comments

Comments
 (0)