Skip to content

Commit 9ffcee1

Browse files
committed
Code review comments.
1 parent bb36472 commit 9ffcee1

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

sdk/include/opentelemetry/sdk/configuration/configuration.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,15 @@
3434
* Yaml node OpenTelemetryConfiguration,
3535
* in file
3636
* https://github.com/open-telemetry/opentelemetry-configuration/blob/main/schema/opentelemetry_configuration.json
37+
*
38+
* Every property in the yaml schema is already documented in the
39+
* opentelemetry-configuration repository,
40+
* in file schema/type_descriptions.yaml, see
41+
* https://github.com/open-telemetry/opentelemetry-configuration/blob/main/schema/type_descriptions.yaml
42+
*
43+
* As a result, C++ class members representing yaml properties are not
44+
* commented with details, refer to the source of truth in
45+
* type_descriptions.yaml directly.
3746
*/
3847

3948
OPENTELEMETRY_BEGIN_NAMESPACE

0 commit comments

Comments
 (0)