Skip to content

Commit d706480

Browse files
doc: Add comments to FIELD_* constants in proxy.h
1 parent 3c69d12 commit d706480

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

include/mp/proxy.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -304,11 +304,11 @@ struct ProxyServerMethodTraits : public ProxyMethodTraits<MethodParams>
304304
{
305305
};
306306

307-
static constexpr int FIELD_IN = 1;
308-
static constexpr int FIELD_OUT = 2;
309-
static constexpr int FIELD_OPTIONAL = 4;
310-
static constexpr int FIELD_REQUESTED = 8;
311-
static constexpr int FIELD_BOXED = 16;
307+
static constexpr int FIELD_IN = 1; //!< Field is read from the Cap'n Proto Params struct (client -> server).
308+
static constexpr int FIELD_OUT = 2; //!< Field is read from the Cap'n Proto Results struct (server -> client).
309+
static constexpr int FIELD_OPTIONAL = 4; //!< Field has a `has<Field>` sibling in the Cap'n Proto schema; value may be absent and presence must be checked via `has()`.
310+
static constexpr int FIELD_REQUESTED = 8; //!< Field has a `want<Field>` sibling in the Cap'n Proto Params struct; client opts in to receiving it.
311+
static constexpr int FIELD_BOXED = 16; //!< Field is a Cap'n Proto pointer type (struct, list, text, data, interface); value may be absent and presence must be checked via `has()`.
312312

313313
//! Accessor type holding flags that determine how to access a message field.
314314
template <typename Field, int flags>

0 commit comments

Comments
 (0)