Skip to content

Commit d263424

Browse files
committed
Improve docstrings.
1 parent 52544d8 commit d263424

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

components/core/src/clp_s/timestamp_parser/TimestampParser.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ find_first_matching_prefix(std::string_view str, std::span<std::string_view cons
252252
* Marshals a date-time timestamp according to a timestamp pattern.
253253
* @param timestamp
254254
* @param pattern
255-
* @param buffer
255+
* @param buffer The buffer that the marshalled timestamp is appended to.
256256
* @return A void result on success, or an error code indicating the failure:
257257
* - ErrorCodeEnum::InvalidTimestampPattern if `pattern` contains format malformed format
258258
* specifiers, or format specifiers that aren't supported in date-time timestamps.
@@ -268,7 +268,7 @@ auto marshal_date_time_timestamp(
268268
* Marshals a numeric timestamp according to a timestamp pattern.
269269
* @param timestamp
270270
* @param pattern
271-
* @param buffer
271+
* @param buffer The buffer that the marshalled timestamp is appended to.
272272
* @return A void result on success, or an error code indicating the failure:
273273
* - ErrorCodeEnum::InvalidTimestampPattern if `pattern` contains format specifiers that aren't
274274
* supported in numeric timestamps.

components/core/src/clp_s/timestamp_parser/TimestampParser.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ class TimestampPattern {
153153
* Marshals a timestamp according to a timestamp pattern.
154154
* @param timestamp
155155
* @param pattern
156-
* @param buffer
156+
* @param buffer The buffer that the marshalled timestamp is appended to.
157157
* @return A void result on success, or an error code indicating the failure:
158158
* - Forwards `marshal_date_time_timestamp`'s return values.
159159
* - Forwards `marshal_numeric_timestamp`'s return values.

0 commit comments

Comments
 (0)