From ec9a78cc4a7ad202a16d83b8673fc77b87eb327c Mon Sep 17 00:00:00 2001 From: Nick Brassel Date: Thu, 16 Sep 2021 11:43:19 +1000 Subject: [PATCH] Doco update. --- data/xap/xap_0.1.0.hjson | 2 +- docs/xap_0.1.0.md | 2 +- docs/xap_0.2.0.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/data/xap/xap_0.1.0.hjson b/data/xap/xap_0.1.0.hjson index e24978f459..f74f177339 100755 --- a/data/xap/xap_0.1.0.hjson +++ b/data/xap/xap_0.1.0.hjson @@ -59,7 +59,7 @@ ''' "struct{}": ''' - A structure of data, packing different objects together. Data is "compacted" -- there are no padding bytes between fields. Equivalent to a C-style `struct`. The order in which they're defined matches the order of the data in the response packet. + A structure of data, packing different objects together. Data is "compacted" -- there are no padding bytes between fields. Equivalent to a packed C-style `struct`. The order in which they're defined matches the order of the data in the response packet. ''' } diff --git a/docs/xap_0.1.0.md b/docs/xap_0.1.0.md index 8dac167209..8d53f276bf 100644 --- a/docs/xap_0.1.0.md +++ b/docs/xap_0.1.0.md @@ -8,7 +8,7 @@ This document describes the requirements of the QMK XAP ("extensible application | Name | Definition | | -- | -- | -| _struct{}_ | A structure of data, packing different objects together. Data is "compacted" -- there are no padding bytes between fields. Equivalent to a C-style `struct`. The order in which they're defined matches the order of the data in the response packet. | +| _struct{}_ | A structure of data, packing different objects together. Data is "compacted" -- there are no padding bytes between fields. Equivalent to a packed C-style `struct`. The order in which they're defined matches the order of the data in the response packet. | | _type[n]_ | An array of `type`, with array extent of `N` -- e.g. `u8[2]` signifies two consecutive octets. | | _u16_ | An unsigned 16-bit integral, commonly seen as `uint16_t` from _stdint.h_. | | _u32_ | An unsigned 32-bit integral, commonly seen as `uint32_t` from _stdint.h_. | diff --git a/docs/xap_0.2.0.md b/docs/xap_0.2.0.md index 8dac167209..8d53f276bf 100644 --- a/docs/xap_0.2.0.md +++ b/docs/xap_0.2.0.md @@ -8,7 +8,7 @@ This document describes the requirements of the QMK XAP ("extensible application | Name | Definition | | -- | -- | -| _struct{}_ | A structure of data, packing different objects together. Data is "compacted" -- there are no padding bytes between fields. Equivalent to a C-style `struct`. The order in which they're defined matches the order of the data in the response packet. | +| _struct{}_ | A structure of data, packing different objects together. Data is "compacted" -- there are no padding bytes between fields. Equivalent to a packed C-style `struct`. The order in which they're defined matches the order of the data in the response packet. | | _type[n]_ | An array of `type`, with array extent of `N` -- e.g. `u8[2]` signifies two consecutive octets. | | _u16_ | An unsigned 16-bit integral, commonly seen as `uint16_t` from _stdint.h_. | | _u32_ | An unsigned 32-bit integral, commonly seen as `uint32_t` from _stdint.h_. |