diff options
author | David Robillard <d@drobilla.net> | 2024-11-24 21:19:14 -0500 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2024-11-24 21:19:24 -0500 |
commit | 2de7788dcff3de47b6c60da2d40ff9bce72b5774 (patch) | |
tree | 7f864c67cd2ad968de79dfa8477b5c1ff91ca3a9 | |
parent | 58f8902bad955d31465335329836cc8b40a40bc1 (diff) | |
download | jalv-2de7788dcff3de47b6c60da2d40ff9bce72b5774.tar.gz jalv-2de7788dcff3de47b6c60da2d40ff9bce72b5774.tar.bz2 jalv-2de7788dcff3de47b6c60da2d40ff9bce72b5774.zip |
Fix typos and improve documentation
-rw-r--r-- | src/comm.h | 11 |
1 files changed, 4 insertions, 7 deletions
@@ -42,8 +42,7 @@ typedef struct { /** The payload of a CONTROL_PORT_CHANGE message. - This message has a fixed sized, and is described in its entirety by this - struct. + This message has a fixed size, this struct defines the entire payload. */ typedef struct { uint32_t port_index; ///< Control port index @@ -53,7 +52,7 @@ typedef struct { /** The start of the payload of an EVENT_TRANSFER message. - This message has a variable size, the start described by this struct is + This message has a variable size, the start, described by this struct, is followed immediately by `atom.size` bytes of data (the atom body). */ typedef struct { @@ -64,8 +63,7 @@ typedef struct { /** The payload of a LATENCY_CHANGE message. - This message has a fixed sized, and is described in its entirety by this - struct. + This message has a fixed size, this struct defines the entire payload. */ typedef struct { float value; ///< Latency in frames at the current sample rate @@ -74,8 +72,7 @@ typedef struct { /** The payload of a RUN_STATE_CHANGE message. - This message has a fixed sized, and is described in its entirety by this - struct. + This message has a fixed size, this struct defines the entire payload. */ typedef struct { JalvRunState state; ///< Run state to change to |