Added missing documentation to the source code in the Playdate bindings target.

2026-07-25 12:55:53 +02:00
parent b435a6e8bd
commit 91783deb7b
63 changed files with 259 additions and 3 deletions
@@ -1,9 +1,14 @@
 internal import CPlaydate

+/// The cached `playdate->network->http` C API table.
 private var httpAPI: UnsafePointer<playdate_http> { Playdate.httpAPI.unsafelyUnwrapped }

 extension Network {
    /// An HTTP connection to a server. Wraps `HTTPConnection`.
+    ///
+    /// The binding stores a back-reference to each wrapper in the
+    /// underlying object's userdata slot so callbacks can recover the
+    /// wrapper; the C userdata slot is therefore reserved by the binding.
    public final class HTTPConnection {
        let pointer: OpaquePointer

@@ -1,9 +1,14 @@
 internal import CPlaydate

+/// The cached `playdate->network->tcp` C API table.
 private var tcpAPI: UnsafePointer<playdate_tcp> { Playdate.tcpAPI.unsafelyUnwrapped }

 extension Network {
    /// A TCP connection to a server. Wraps `TCPConnection`.
+    ///
+    /// The binding stores a back-reference to each wrapper in the
+    /// underlying object's userdata slot so callbacks can recover the
+    /// wrapper; the C userdata slot is therefore reserved by the binding.
    public final class TCPConnection {
        let pointer: OpaquePointer