From: Matt Corallo <git@bluematt.me>
Date: Tue, 28 Jun 2022 02:14:20 +0000 (+0000)
Subject: Add a note in output documentation for fields with refs to opaques
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=ef521e155d142222012acc4b33a41e13c0bda6ee;hp=ef521e155d142222012acc4b33a41e13c0bda6ee;p=ldk-c-bindings

Add a note in output documentation for fields with refs to opaques

Because we (probably shouldn't, but do) map "opaque" structs with
an `is_owned` field instead of having a dedicated reference type,
fields which are a `Deref<Struct>` are simply mapped as
`OpaqueMappedStruct`. This is confusing for downstream `lightning.h`
consumers as they cannot differentiate between a field that expects
to own a `Struct` and one which expects to own a reference to it.

This is worked around here by adding documentation which can be
matched on, though ultimately structs should move towards full
ownership.
---