Skip to content

Commit 960e4da

Browse files
authored
Polish Javadoc for TestObservationRegistryAssert (#3696)
1 parent cb1358a commit 960e4da

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

micrometer-observation-test/src/main/java/io/micrometer/observation/tck/TestObservationRegistryAssert.java

+22-13
Original file line numberDiff line numberDiff line change
@@ -166,11 +166,12 @@ public TestObservationRegistryAssert hasHandledContextsThatSatisfy(
166166
/**
167167
* Provides verification for all Observations having the given name.
168168
* <p>
169-
* Examples: <pre><code class='java'> // assertions succeed
170-
* assertThat(testObservationRegistry).forAllObservationsWithNameEqualTo("foo", ObservationContextAssert -&gt; ObservationContextAssert.hasError());
169+
* Examples: <pre><code class='java'>
170+
* // assertions succeed
171+
* assertThat(testObservationRegistry).forAllObservationsWithNameEqualTo("foo", observationContextAssert -&gt; observationContextAssert.hasError());
171172
*
172173
* // assertions fail - assuming that there was a foo observation but none had errors
173-
* assertThat(testObservationRegistry).forAllObservationsWithNameEqualTo("foo", ObservationContextAssert -&gt; ObservationContextAssert.hasError());</code></pre>
174+
* assertThat(testObservationRegistry).forAllObservationsWithNameEqualTo("foo", observationContextAssert -&gt; observationContextAssert.hasError());</code></pre>
174175
* @param name searched Observation name
175176
* @param observationConsumer assertion to be executed for each Observation
176177
* @return {@code this} assertion object.
@@ -194,11 +195,12 @@ public TestObservationRegistryAssert forAllObservationsWithNameEqualTo(String na
194195
/**
195196
* Provides verification for all Observations having the given name (ignoring case).
196197
* <p>
197-
* Examples: <pre><code class='java'> // assertions succeed
198-
* assertThat(testObservationRegistry).forAllObservationsWithNameEqualTo("foo", ObservationContextAssert -&gt; ObservationContextAssert.hasError());
198+
* Examples: <pre><code class='java'>
199+
* // assertions succeed
200+
* assertThat(testObservationRegistry).forAllObservationsWithNameEqualTo("foo", observationContextAssert -&gt; observationContextAssert.hasError());
199201
*
200202
* // assertions fail - assuming that there was a foo observation but none had errors
201-
* assertThat(testObservationRegistry).forAllObservationsWithNameEqualTo("foo", ObservationContextAssert -&gt; ObservationContextAssert.hasError());</code></pre>
203+
* assertThat(testObservationRegistry).forAllObservationsWithNameEqualTo("foo", observationContextAssert -&gt; observationContextAssert.hasError());</code></pre>
202204
* @param name searched Observation name (ignoring case)
203205
* @param observationConsumer assertion to be executed for each Observation
204206
* @return {@code this} assertion object.
@@ -223,7 +225,8 @@ public TestObservationRegistryAssert forAllObservationsWithNameEqualToIgnoreCase
223225
/**
224226
* Verifies that there is a proper number of Observations.
225227
* <p>
226-
* Examples: <pre><code class='java'> // assertions succeed
228+
* Examples: <pre><code class='java'>
229+
* // assertions succeed
227230
* assertThat(testObservationRegistry).hasNumberOfObservationsEqualTo(1);
228231
*
229232
* // assertions fail - assuming that there was only 1 observation
@@ -247,7 +250,8 @@ public TestObservationRegistryAssert hasNumberOfObservationsEqualTo(int expected
247250
/**
248251
* Verifies that there is a proper number of Observations with the given name.
249252
* <p>
250-
* Examples: <pre><code class='java'> // assertions succeed
253+
* Examples: <pre><code class='java'>
254+
* // assertions succeed
251255
* assertThat(testObservationRegistry).hasNumberOfObservationsWithNameEqualTo("foo", 1);
252256
*
253257
* // assertions fail - assuming that there is only 1 observation with that name
@@ -280,7 +284,8 @@ public TestObservationRegistryAssert hasNumberOfObservationsWithNameEqualTo(Stri
280284
* Verifies that there is a proper number of Observations with the given name
281285
* (ignoring case).
282286
* <p>
283-
* Examples: <pre><code class='java'> // assertions succeed
287+
* Examples: <pre><code class='java'>
288+
* // assertions succeed
284289
* assertThat(testObservationRegistry).hasNumberOfObservationsWithNameEqualToIgnoreCase("foo", 1);
285290
*
286291
* // assertions fail - assuming that there's only 1 such observation
@@ -312,7 +317,8 @@ public TestObservationRegistryAssert hasNumberOfObservationsWithNameEqualToIgnor
312317
/**
313318
* Verifies that there is an Observation with a key value.
314319
* <p>
315-
* Examples: <pre><code class='java'> // assertions succeed
320+
* Examples: <pre><code class='java'>
321+
* // assertions succeed
316322
* assertThat(testObservationRegistry).hasAnObservationWithAKeyValue("foo", "bar");
317323
*
318324
* // assertions fail - assuming that there is no such a key value in any observation
@@ -342,7 +348,8 @@ public TestObservationRegistryAssert hasAnObservationWithAKeyValue(String key, S
342348
/**
343349
* Verifies that there is an Observation with a key name.
344350
* <p>
345-
* Examples: <pre><code class='java'> // assertions succeed
351+
* Examples: <pre><code class='java'>
352+
* // assertions succeed
346353
* assertThat(testObservationRegistry).hasAnObservationWithAKeyName("foo");
347354
*
348355
* // assertions fail - assuming that there are no observations with such a key name
@@ -371,7 +378,8 @@ public TestObservationRegistryAssert hasAnObservationWithAKeyName(String key) {
371378
/**
372379
* Verifies that there is an Observation with a key value.
373380
* <p>
374-
* Examples: <pre><code class='java'> // assertions succeed
381+
* Examples: <pre><code class='java'>
382+
* // assertions succeed
375383
* assertThat(testObservationRegistry).hasAnObservationWithAKeyValue(SomeKeyName.FOO, "bar");
376384
*
377385
* // assertions fail - assuming that there are no observations with such a key value
@@ -389,7 +397,8 @@ public TestObservationRegistryAssert hasAnObservationWithAKeyValue(KeyName key,
389397
/**
390398
* Verifies that there is an Observation with a key name.
391399
* <p>
392-
* Examples: <pre><code class='java'> // assertions succeed
400+
* Examples: <pre><code class='java'>
401+
* // assertions succeed
393402
* assertThat(testObservationRegistry).hasAnObservationWithAKeyName(SomeKeyName.FOO);
394403
*
395404
* // assertions fail - assuming that there are no observation with such a key name

0 commit comments

Comments
 (0)