From 8c01c233dd2e2ca55cf0c02b7c2df18d38269bec Mon Sep 17 00:00:00 2001 From: Georg Reinke Date: Thu, 6 Jan 2022 18:50:37 +0100 Subject: [PATCH] doc: clarify struct order and link to spec for types Fixes #234. --- doc.go | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc.go b/doc.go index ade1df95..8f25a00d 100644 --- a/doc.go +++ b/doc.go @@ -10,8 +10,10 @@ value. Conversion Rules For outgoing messages, Go types are automatically converted to the -corresponding D-Bus types. The following types are directly encoded as their -respective D-Bus equivalents: +corresponding D-Bus types. See the official specification at +https://dbus.freedesktop.org/doc/dbus-specification.html#type-system for more +information on the D-Bus type system. The following types are directly encoded +as their respective D-Bus equivalents: Go type | D-Bus type ------------+----------- @@ -39,8 +41,8 @@ Maps encode as DICTs, provided that their key type can be used as a key for a DICT. Structs other than Variant and Signature encode as a STRUCT containing their -exported fields. Fields whose tags contain `dbus:"-"` and unexported fields will -be skipped. +exported fields in order. Fields whose tags contain `dbus:"-"` and unexported +fields will be skipped. Pointers encode as the value they're pointed to.