[SEMANTIC CONVENTIONS] Fix comment style to preserve markup (open-telemetry#3444)

Author: marcalff

CHANGELOG.md

@@ -70,6 +70,9 @@ Increment the:
 * [TEST] Test all components in a CMake super build
   [#3433](https://github.com/open-telemetry/opentelemetry-cpp/pull/3433)
 
+* [SEMANTIC CONVENTIONS] Fix comment style to preserve markup.
+  [#3444](https://github.com/open-telemetry/opentelemetry-cpp/pull/3444)
+
 Important changes:
 
 * [EXPORTER] ostream log exporter, fixed memory ownership issues

api/include/opentelemetry/semconv/client_attributes.h

@@ -20,19 +20,19 @@ namespace client
 {
 
 /**
- * Client address - domain name if available without reverse DNS lookup; otherwise, IP address or
- * Unix domain socket name. <p> When observed from the server side, and when communicating through
- * an intermediary, @code client.address @endcode SHOULD represent the client address behind any
- * intermediaries,  for example proxies, if it's available.
+  Client address - domain name if available without reverse DNS lookup; otherwise, IP address or
+  Unix domain socket name. <p> When observed from the server side, and when communicating through an
+  intermediary, @code client.address @endcode SHOULD represent the client address behind any
+  intermediaries,  for example proxies, if it's available.
  */
 static constexpr const char *kClientAddress = "client.address";
 
 /**
- * Client port number.
- * <p>
- * When observed from the server side, and when communicating through an intermediary, @code
- * client.port @endcode SHOULD represent the client port behind any intermediaries,  for example
- * proxies, if it's available.
+  Client port number.
+  <p>
+  When observed from the server side, and when communicating through an intermediary, @code
+  client.port @endcode SHOULD represent the client port behind any intermediaries,  for example
+  proxies, if it's available.
  */
 static constexpr const char *kClientPort = "client.port";
 

api/include/opentelemetry/semconv/code_attributes.h

@@ -20,59 +20,59 @@ namespace code
 {
 
 /**
- * The column number in @code code.file.path @endcode best representing the operation. It SHOULD
- * point within the code unit named in @code code.function.name @endcode. This attribute MUST NOT be
- * used on the Profile signal since the data is already captured in 'message Line'. This constraint
- * is imposed to prevent redundancy and maintain data integrity.
+  The column number in @code code.file.path @endcode best representing the operation. It SHOULD
+  point within the code unit named in @code code.function.name @endcode. This attribute MUST NOT be
+  used on the Profile signal since the data is already captured in 'message Line'. This constraint
+  is imposed to prevent redundancy and maintain data integrity.
  */
 static constexpr const char *kCodeColumnNumber = "code.column.number";
 
 /**
- * The source code file name that identifies the code unit as uniquely as possible (preferably an
- * absolute file path). This attribute MUST NOT be used on the Profile signal since the data is
- * already captured in 'message Function'. This constraint is imposed to prevent redundancy and
- * maintain data integrity.
+  The source code file name that identifies the code unit as uniquely as possible (preferably an
+  absolute file path). This attribute MUST NOT be used on the Profile signal since the data is
+  already captured in 'message Function'. This constraint is imposed to prevent redundancy and
+  maintain data integrity.
  */
 static constexpr const char *kCodeFilePath = "code.file.path";
 
 /**
- * The method or function fully-qualified name without arguments. The value should fit the natural
- * representation of the language runtime, which is also likely the same used within @code
- * code.stacktrace @endcode attribute value. This attribute MUST NOT be used on the Profile signal
- * since the data is already captured in 'message Function'. This constraint is imposed to prevent
- * redundancy and maintain data integrity. <p> Values and format depends on each language runtime,
- * thus it is impossible to provide an exhaustive list of examples. The values are usually the same
- * (or prefixes of) the ones found in native stack trace representation stored in
- * @code code.stacktrace @endcode without information on arguments.
- * <p>
- * Examples:
- * <ul>
- *   <li>Java method: @code com.example.MyHttpService.serveRequest @endcode</li>
- *   <li>Java anonymous class method: @code com.mycompany.Main$1.myMethod @endcode</li>
- *   <li>Java lambda method: @code com.mycompany.Main$$Lambda/0x0000748ae4149c00.myMethod
- * @endcode</li> <li>PHP function: @code GuzzleHttp\Client::transfer @endcode</li> <li>Go function:
- * @code github.com/my/repo/pkg.foo.func5 @endcode</li> <li>Elixir: @code OpenTelemetry.Ctx.new
- * @endcode</li> <li>Erlang: @code opentelemetry_ctx:new @endcode</li> <li>Rust: @code
- * playground::my_module::my_cool_func @endcode</li> <li>C function: @code fopen @endcode</li>
- * </ul>
+  The method or function fully-qualified name without arguments. The value should fit the natural
+  representation of the language runtime, which is also likely the same used within @code
+  code.stacktrace @endcode attribute value. This attribute MUST NOT be used on the Profile signal
+  since the data is already captured in 'message Function'. This constraint is imposed to prevent
+  redundancy and maintain data integrity. <p> Values and format depends on each language runtime,
+  thus it is impossible to provide an exhaustive list of examples. The values are usually the same
+  (or prefixes of) the ones found in native stack trace representation stored in
+  @code code.stacktrace @endcode without information on arguments.
+  <p>
+  Examples:
+  <ul>
+    <li>Java method: @code com.example.MyHttpService.serveRequest @endcode</li>
+    <li>Java anonymous class method: @code com.mycompany.Main$1.myMethod @endcode</li>
+    <li>Java lambda method: @code com.mycompany.Main$$Lambda/0x0000748ae4149c00.myMethod
+  @endcode</li> <li>PHP function: @code GuzzleHttp\Client::transfer @endcode</li> <li>Go function:
+  @code github.com/my/repo/pkg.foo.func5 @endcode</li> <li>Elixir: @code OpenTelemetry.Ctx.new
+  @endcode</li> <li>Erlang: @code opentelemetry_ctx:new @endcode</li> <li>Rust: @code
+  playground::my_module::my_cool_func @endcode</li> <li>C function: @code fopen @endcode</li>
+  </ul>
  */
 static constexpr const char *kCodeFunctionName = "code.function.name";
 
 /**
- * The line number in @code code.file.path @endcode best representing the operation. It SHOULD point
- * within the code unit named in @code code.function.name @endcode. This attribute MUST NOT be used
- * on the Profile signal since the data is already captured in 'message Line'. This constraint is
- * imposed to prevent redundancy and maintain data integrity.
+  The line number in @code code.file.path @endcode best representing the operation. It SHOULD point
+  within the code unit named in @code code.function.name @endcode. This attribute MUST NOT be used
+  on the Profile signal since the data is already captured in 'message Line'. This constraint is
+  imposed to prevent redundancy and maintain data integrity.
  */
 static constexpr const char *kCodeLineNumber = "code.line.number";
 
 /**
- * A stacktrace as a string in the natural representation for the language runtime. The
- * representation is identical to <a
- * href="/docs/exceptions/exceptions-spans.md#stacktrace-representation">@code exception.stacktrace
- * @endcode</a>. This attribute MUST NOT be used on the Profile signal since the data is already
- * captured in 'message Location'. This constraint is imposed to prevent redundancy and maintain
- * data integrity.
+  A stacktrace as a string in the natural representation for the language runtime. The
+  representation is identical to <a
+  href="/docs/exceptions/exceptions-spans.md#stacktrace-representation">@code exception.stacktrace
+  @endcode</a>. This attribute MUST NOT be used on the Profile signal since the data is already
+  captured in 'message Location'. This constraint is imposed to prevent redundancy and maintain data
+  integrity.
  */
 static constexpr const char *kCodeStacktrace = "code.stacktrace";