ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

And sort out docs gen too

Browse source
This commit is contained in:
zvecr 2022-03-31 23:16:56 +01:00
parent 53052228df
commit 2c8c9c9928
5 changed files with 22 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

3
data/templates/xap/docs/term_definitions.md.j2
View file

@ -2,4 +2,7 @@
| -- | -- |
{%- for type, definition in xap.term_definitions | dictsort %}
| _{{ type }}_ | {{ definition }} |
{%- endfor %}
{%- for type, definition in xap.types | dictsort %}
| _{{ definition.name }}_ | {{ definition.description }}{% if 'struct' == definition.type %} Takes the format:{% for item in definition.struct_members %}<br>`{{ item.type }}` - {{ item.name }}{%- endfor %}{% endif %} |
{%- endfor %}

10
data/xap/xap_0.0.1.hjson
View file

@ -122,25 +122,25 @@
types: {
identifier: {
name: ID
description: Subsystem/Route ID
description: A single octet / 8-bit byte, representing Subsystem or Route index.
type: u8
}
response_flags: {
name: Response Flags
description: Contains the status of the request
description: An `u8` containing the status of the request.
type: u8
}
token: {
name: Token
description: ID associated with a specific request as well as its corresponding response
description: A `u16` associated with a specific request as well as its corresponding response.
type: u16
}
request_header: {
name: Request Header
description: asdf
description: Packet format for inbound data.
type: struct
struct_members: [
{
@ -156,7 +156,7 @@
response_header: {
name: Response Header
description: asdf
description: Packet format for inbound data.
type: struct
struct_members: [
{