Skip to content

Commit e30863f

Browse files
committed
Fix the doc comments
1 parent 210c863 commit e30863f

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

api/include/opentelemetry/common/key_value_iterable.h

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,10 @@ class NoopKeyValueIterable : public KeyValueIterable
4242
public:
4343
~NoopKeyValueIterable() override = default;
4444

45-
/**
46-
* Iterate over key-value pairs
47-
* A callback to invoke for each key-value. If the callback returns false,
48-
* the iteration is aborted.
49-
* @return true if every key-value pair was iterated over
50-
*/
45+
/**
46+
* No-op implementation: does not invoke the callback, even if key-value pairs are present.
47+
* @return true without iterating or invoking the callback
48+
*/
5149
bool ForEachKeyValue(
5250
nostd::function_ref<bool(nostd::string_view, common::AttributeValue)> /*callback*/) const noexcept override
5351
{

api/include/opentelemetry/common/key_value_iterable_view.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,16 +130,17 @@ inline static const common::KeyValueIterable &MakeAttributes(
130130
/**
131131
* Utility function to help to make a attribute view from a key-value iterable object
132132
*
133-
* @param arg The key-value iterable object
133+
* @tparam ArgumentType Expected to be ArgumentType
134+
* @param attributes The key-value iterable object
134135
* @return nostd::span<const std::pair<nostd::string_view, common::AttributeValue>>
135136
*/
136137
template <
137138
class ArgumentType,
138139
nostd::enable_if_t<common::detail::is_key_value_iterable<ArgumentType>::value> * = nullptr>
139140
inline static common::KeyValueIterableView<ArgumentType> MakeAttributes(
140-
const ArgumentType &arg) noexcept
141+
const ArgumentType &attributes) noexcept
141142
{
142-
return common::KeyValueIterableView<ArgumentType>(arg);
143+
return common::KeyValueIterableView<ArgumentType>(attributes);
143144
}
144145

145146
} // namespace common

0 commit comments

Comments
 (0)