Skip to content

Commit e3c83f5

Browse files
committed
Fix the doc comment issues in semconv
1 parent 15c3fd6 commit e3c83f5

File tree

1 file changed

+22
-28
lines changed

1 file changed

+22
-28
lines changed

api/include/opentelemetry/semconv/incubating/url_attributes.h

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ namespace url
2323
* Domain extracted from the @code url.full @endcode, such as "opentelemetry.io".
2424
* <p>
2525
* In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case,
26-
* the IP address would go to the domain field. If the URL contains a <a
27-
* href="https://www.rfc-editor.org/rfc/rfc2732#section-2">literal IPv6 address</a> enclosed by
26+
* the IP address would go to the domain field. If the URL contains a
27+
* <a href="https://www.rfc-editor.org/rfc/rfc2732#section-2">literal IPv6 address</a> enclosed by
2828
* @code [ @endcode and @code ] @endcode, the @code [ @endcode and @code ] @endcode characters
2929
* should also be captured in the domain field.
3030
*/
@@ -45,8 +45,8 @@ static constexpr const char *kUrlExtension = "url.extension";
4545
static constexpr const char *kUrlFragment = "url.fragment";
4646

4747
/**
48-
* Absolute URL describing a network resource according to <a
49-
* href="https://www.rfc-editor.org/rfc/rfc3986">RFC3986</a> <p> For network calls, URL usually has
48+
* Absolute URL describing a network resource according to
49+
* <a href="https://www.rfc-editor.org/rfc/rfc3986">RFC3986</a> <p> For network calls, URL usually has
5050
* @code scheme://host[:port][path][?query][#fragment] @endcode format, where the fragment is not
5151
* transmitted over HTTP, but if it is known, it SHOULD be included nevertheless. <p>
5252
* @code url.full @endcode MUST NOT contain credentials passed via URL in form of @code
@@ -60,15 +60,12 @@ static constexpr const char *kUrlFragment = "url.fragment";
6060
* Query string values for the following keys SHOULD be redacted by default and replaced by the
6161
* value @code REDACTED @endcode:
6262
* <ul>
63-
* <li><a
64-
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
65-
* AWSAccessKeyId @endcode</a></li> <li><a
66-
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
67-
* Signature @endcode</a></li> <li><a
68-
* href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token">@code sig
69-
* @endcode</a></li> <li><a
70-
* href="https://cloud.google.com/storage/docs/access-control/signed-urls">@code X-Goog-Signature
71-
* @endcode</a></li>
63+
* <li>
64+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth"> @code AWSAccessKeyId @endcode</a>
65+
* </li> <li>
66+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth"> @code Signature @endcode</a>
67+
* </li> <li><a href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token"> @code sig @endcode</a>
68+
* </li> <li><a href="https://cloud.google.com/storage/docs/access-control/signed-urls">@code X-Goog-Signature @endcode</a></li>
7269
* </ul>
7370
* <p>
7471
* This list is subject to change over time.
@@ -110,15 +107,11 @@ static constexpr const char *kUrlPort = "url.port";
110107
* can identify it. <p>
111108
*
112109
* Query string values for the following keys SHOULD be redacted by default and replaced by the
113-
* value @code REDACTED @endcode: <ul> <li><a
114-
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
115-
* AWSAccessKeyId @endcode</a></li> <li><a
116-
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
117-
* Signature @endcode</a></li> <li><a
118-
* href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token">@code sig
119-
* @endcode</a></li> <li><a
120-
* href="https://cloud.google.com/storage/docs/access-control/signed-urls">@code X-Goog-Signature
121-
* @endcode</a></li>
110+
* value @code REDACTED @endcode: <ul> <li>
111+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth"> @code AWSAccessKeyId @endcode</a></li>
112+
* <li><a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth"> @code Signature @endcode</a></li>
113+
* <li><a href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token"> @code sig @endcode</a></li>
114+
* <li><a href="https://cloud.google.com/storage/docs/access-control/signed-urls">@code X-Goog-Signature @endcode</a></li>
122115
* </ul>
123116
* <p>
124117
* This list is subject to change over time.
@@ -131,8 +124,9 @@ static constexpr const char *kUrlQuery = "url.query";
131124
/**
132125
* The highest registered url domain, stripped of the subdomain.
133126
* <p>
134-
* This value can be determined precisely with the <a href="https://publicsuffix.org/">public suffix
135-
* list</a>. For example, the registered domain for @code foo.example.com @endcode is @code
127+
* This value can be determined precisely with the
128+
* <a href="https://publicsuffix.org/">public suffix list</a>.
129+
* For example, the registered domain for @code foo.example.com @endcode is @code
136130
* example.com @endcode. Trying to approximate this by simply taking the last two labels will not
137131
* work well for TLDs such as @code co.uk @endcode.
138132
*/
@@ -155,16 +149,16 @@ static constexpr const char *kUrlScheme = "url.scheme";
155149
static constexpr const char *kUrlSubdomain = "url.subdomain";
156150

157151
/**
158-
* The low-cardinality template of an <a
159-
* href="https://www.rfc-editor.org/rfc/rfc3986#section-4.2">absolute path reference</a>.
152+
* The low-cardinality template of an
153+
* <a href="https://www.rfc-editor.org/rfc/rfc3986#section-4.2">absolute path reference</a>.
160154
*/
161155
static constexpr const char *kUrlTemplate = "url.template";
162156

163157
/**
164158
* The effective top level domain (eTLD), also known as the domain suffix, is the last part of the
165159
* domain name. For example, the top level domain for example.com is @code com @endcode. <p> This
166-
* value can be determined precisely with the <a href="https://publicsuffix.org/">public suffix
167-
* list</a>.
160+
* value can be determined precisely with the
161+
* <a href="https://publicsuffix.org/">public suffix list</a>.
168162
*/
169163
static constexpr const char *kUrlTopLevelDomain = "url.top_level_domain";
170164

0 commit comments

Comments
 (0)