Update docstrings

This commit is contained in:
2025-08-15 16:35:16 -04:00
parent 4e8d3a4c61
commit f6fbb3b3f0
2 changed files with 13 additions and 37 deletions

View File

@@ -49,7 +49,7 @@ class CommitRequest {
};
/**
* @brief Represents an operation in a commit request.
* @brief Internal state for parsing an operation during JSON processing.
*/
struct OperationParseState {
Operation::Type type;
@@ -142,8 +142,7 @@ private:
public:
/**
* @brief Construct a new CommitRequest with the given initial arena size.
* @param arena_size Initial size for the arena allocator
* @brief Construct a new CommitRequest with default arena size.
*/
explicit CommitRequest()
: arena_(), preconditions_(ArenaStlAllocator<Precondition>(&arena_)),
@@ -198,7 +197,8 @@ public:
/**
* @brief Parse a JSON string into a CommitRequest object (one-shot parsing).
* @param json_str The JSON string to parse
* @param data Pointer to the JSON data buffer
* @param len Length of the data in bytes
* @return true if parsing succeeded, false otherwise
*/
bool parse_json(char *data, size_t len);