Add SeeAlso documentation to OTel span attributes

slashmo · slashmo · commit 30391e15ad81 · 2020-08-19T12:42:12.000+02:00
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+EndUser.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+EndUser.swift
@@ -33,6 +33,8 @@ extension SpanAttributes {
 }
 
 /// End-user-related semantic conventions as defined in the OpenTelemetry spec.
+///
+/// - SeeAlso: [OpenTelemetry: General identity attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/b70565d5a8a13d26c91fb692879dc874d22c3ac8/specification/trace/semantic_conventions/span-general.md#general-identity-attributes) (as of August 2020)
 @dynamicMemberLookup
 public struct EndUserAttributes: SpanAttributeNamespace {
     public var attributes: SpanAttributes
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+HTTPSemantics.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+HTTPSemantics.swift
@@ -46,6 +46,8 @@ extension SpanAttributes {
 }
 
 /// Semantic conventions for HTTP spans as defined in the OpenTelemetry spec.
+///
+/// - SeeAlso: [OpenTelemetry: Semantic conventions for HTTP spans](https://github.com/open-telemetry/opentelemetry-specification/blob/b70565d5a8a13d26c91fb692879dc874d22c3ac8/specification/trace/semantic_conventions/http.md) (as of August 2020)
 @dynamicMemberLookup
 public struct HTTPAttributes: SpanAttributeNamespace {
     public var attributes: SpanAttributes
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+NetSemantics.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+NetSemantics.swift
@@ -37,6 +37,8 @@ extension SpanAttributes {
 }
 
 /// Network-related semantic conventions as defined in the OpenTelemetry spec.
+///
+/// - SeeAlso: [OpenTelemetry: General semantic attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/b70565d5a8a13d26c91fb692879dc874d22c3ac8/specification/trace/semantic_conventions/span-general.md) (as of August 2020)
 @dynamicMemberLookup
 public struct NetAttributes: SpanAttributeNamespace {
     public var attributes: SpanAttributes
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+PeerSemantics.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+PeerSemantics.swift
@@ -31,6 +31,8 @@ extension SpanAttributes {
 }
 
 /// Peer-related semantic conventions as defined in the OpenTelemetry spec.
+///
+/// - SeeAlso: [OpenTelemetry: General remote service attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/b70565d5a8a13d26c91fb692879dc874d22c3ac8/specification/trace/semantic_conventions/span-general.md#general-remote-service-attributes) (as of August 2020)
 @dynamicMemberLookup
 public struct PeerAttributes: SpanAttributeNamespace {
     public var attributes: SpanAttributes

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,8 @@ extension SpanAttributes {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/// End-user-related semantic conventions as defined in the OpenTelemetry spec.`
	`36`	`+///`
	`37`	`+/// - SeeAlso: [OpenTelemetry: General identity attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/b70565d5a8a13d26c91fb692879dc874d22c3ac8/specification/trace/semantic_conventions/span-general.md#general-identity-attributes) (as of August 2020)`
`36`	`38`	`@dynamicMemberLookup`
`37`	`39`	`public struct EndUserAttributes: SpanAttributeNamespace {`
`38`	`40`	`public var attributes: SpanAttributes`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,8 @@ extension SpanAttributes {`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`/// Semantic conventions for HTTP spans as defined in the OpenTelemetry spec.`
	`49`	`+///`
	`50`	`+/// - SeeAlso: [OpenTelemetry: Semantic conventions for HTTP spans](https://github.com/open-telemetry/opentelemetry-specification/blob/b70565d5a8a13d26c91fb692879dc874d22c3ac8/specification/trace/semantic_conventions/http.md) (as of August 2020)`
`49`	`51`	`@dynamicMemberLookup`
`50`	`52`	`public struct HTTPAttributes: SpanAttributeNamespace {`
`51`	`53`	`public var attributes: SpanAttributes`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,8 @@ extension SpanAttributes {`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`/// Network-related semantic conventions as defined in the OpenTelemetry spec.`
	`40`	`+///`
	`41`	`+/// - SeeAlso: [OpenTelemetry: General semantic attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/b70565d5a8a13d26c91fb692879dc874d22c3ac8/specification/trace/semantic_conventions/span-general.md) (as of August 2020)`
`40`	`42`	`@dynamicMemberLookup`
`41`	`43`	`public struct NetAttributes: SpanAttributeNamespace {`
`42`	`44`	`public var attributes: SpanAttributes`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@ extension SpanAttributes {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`/// Peer-related semantic conventions as defined in the OpenTelemetry spec.`
	`34`	`+///`
	`35`	`+/// - SeeAlso: [OpenTelemetry: General remote service attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/b70565d5a8a13d26c91fb692879dc874d22c3ac8/specification/trace/semantic_conventions/span-general.md#general-remote-service-attributes) (as of August 2020)`
`34`	`36`	`@dynamicMemberLookup`
`35`	`37`	`public struct PeerAttributes: SpanAttributeNamespace {`
`36`	`38`	`public var attributes: SpanAttributes`