Skip to content

Commit 6f15f9f

Browse files
committed
Rename DocumentedSpan to SpanDocumentation
This aligns the naming with the recent change in the micrometer repository for ObservationDocumentation and MeterDocumentation. See micrometer-metrics/micrometer#3430
1 parent 29feef8 commit 6f15f9f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

micrometer-tracing/src/main/java/io/micrometer/tracing/docs/DocumentedSpan.java renamed to micrometer-tracing/src/main/java/io/micrometer/tracing/docs/SpanDocumentation.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,23 @@
2828
* met
2929
*
3030
* <ul>
31-
* <li>Metrics are grouped within an enum - the enum implements the {@link DocumentedSpan}
31+
* <li>Metrics are grouped within an enum - the enum implements the {@link SpanDocumentation}
3232
* interface</li>
3333
* <li>If the span contains {@link KeyName} then those need to be declared as nested
3434
* enums</li>
3535
* <li>If the span contains {@link EventValue} then those need to be declared as nested
3636
* enums</li>
37-
* <li>The {@link DocumentedSpan#getKeyNames()} need to call the nested enum's
37+
* <li>The {@link SpanDocumentation#getKeyNames()} need to call the nested enum's
3838
* {@code values()} method to retrieve the array of allowed keys</li>
39-
* <li>The {@link DocumentedSpan#getEvents()} need to call the nested enum's
39+
* <li>The {@link SpanDocumentation#getEvents()} need to call the nested enum's
4040
* {@code values()} method to retrieve the array of allowed events</li>
4141
* <li>Javadocs around enums will be used as description</li>
4242
* </ul>
4343
*
4444
* @author Marcin Grzejszczak
4545
* @since 1.0.0
4646
*/
47-
public interface DocumentedSpan {
47+
public interface SpanDocumentation {
4848

4949
/**
5050
* Empty key names.
@@ -86,7 +86,7 @@ default EventValue[] getEvents() {
8686
/**
8787
* Allowed key names.
8888
* @return allowed key names - if set will override any key names coming from
89-
* {@link DocumentedSpan#overridesDefaultSpanFrom()}
89+
* {@link SpanDocumentation#overridesDefaultSpanFrom()}
9090
*/
9191
default KeyName[] getKeyNames() {
9292
return EMPTY_KEY_NAMES;
@@ -95,7 +95,7 @@ default KeyName[] getKeyNames() {
9595
/**
9696
* Additional key names.
9797
* @return additional key names - if set will append any key names coming from
98-
* {@link DocumentedSpan#overridesDefaultSpanFrom()}
98+
* {@link SpanDocumentation#overridesDefaultSpanFrom()}
9999
*/
100100
default KeyName[] getAdditionalKeyNames() {
101101
return EMPTY_KEY_NAMES;

0 commit comments

Comments
 (0)