Skip to content

Commit

Permalink
Fix comment
Browse files Browse the repository at this point in the history
  • Loading branch information
LinZhihao-723 committed Nov 24, 2024
1 parent 83871a5 commit 09d2db0
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions components/core/src/clp/ffi/KeyValuePairLogEvent.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,12 @@ class KeyValuePairLogEvent {

/**
* Serializes the log event into `nlohmann::json` objects.
* @return A result containing a pair of serialized JSON objects (the first contains
* auto-generated key-value pairs, while the second contains user-generated key-value pairs), or
* an error code indicating the failure:
* - Forwards `serialize_node_id_value_pairs_to_json`'s return values.
* @return A result containing a pair or an error code indicating the failure:
* - The pair:
* - Serialized auto-generated key-value pairs as a JSON object
* - Serialized user-generated key-value pairs as a JSON object
* - The possible error codes:
* - Forwards `serialize_node_id_value_pairs_to_json`'s return values on failure.
*/
[[nodiscard]] auto serialize_to_json(
) const -> OUTCOME_V2_NAMESPACE::std_result<std::pair<nlohmann::json, nlohmann::json>>;
Expand Down

0 comments on commit 09d2db0

Please sign in to comment.