28
28
* met
29
29
*
30
30
* <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 }
32
32
* interface</li>
33
33
* <li>If the span contains {@link KeyName} then those need to be declared as nested
34
34
* enums</li>
35
35
* <li>If the span contains {@link EventValue} then those need to be declared as nested
36
36
* 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
38
38
* {@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
40
40
* {@code values()} method to retrieve the array of allowed events</li>
41
41
* <li>Javadocs around enums will be used as description</li>
42
42
* </ul>
43
43
*
44
44
* @author Marcin Grzejszczak
45
45
* @since 1.0.0
46
46
*/
47
- public interface DocumentedSpan {
47
+ public interface SpanDocumentation {
48
48
49
49
/**
50
50
* Empty key names.
@@ -86,7 +86,7 @@ default EventValue[] getEvents() {
86
86
/**
87
87
* Allowed key names.
88
88
* @return allowed key names - if set will override any key names coming from
89
- * {@link DocumentedSpan #overridesDefaultSpanFrom()}
89
+ * {@link SpanDocumentation #overridesDefaultSpanFrom()}
90
90
*/
91
91
default KeyName [] getKeyNames () {
92
92
return EMPTY_KEY_NAMES ;
@@ -95,7 +95,7 @@ default KeyName[] getKeyNames() {
95
95
/**
96
96
* Additional key names.
97
97
* @return additional key names - if set will append any key names coming from
98
- * {@link DocumentedSpan #overridesDefaultSpanFrom()}
98
+ * {@link SpanDocumentation #overridesDefaultSpanFrom()}
99
99
*/
100
100
default KeyName [] getAdditionalKeyNames () {
101
101
return EMPTY_KEY_NAMES ;
0 commit comments