Update documentation for new Cocoa function

kosude · Oct 14, 2023 · 679df3e · 679df3e
1 parent 145d868
commit 679df3e
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 5 deletions.
diff --git a/docs/pages/api/core/wsi.rst b/docs/pages/api/core/wsi.rst
@@ -24,18 +24,28 @@ Functions
 ---------
 
 
-For X11 systems - via XCB
+For Cocoa (macOS) systems
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. important::
+    Definitions for these functions is compiled **only if** the ``-DTHALLIUM_WSI_COCOA=ON`` CMake flag was present at build. This is the
+    **default behaviour** on **Apple** systems.
+
+.. doxygenfunction:: TL_WindowSurfaceCreateCocoa
+
+
+For Xorg systems (via xcb)
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 .. important::
     Definitions for these functions is compiled **only if** the ``-DTHALLIUM_WSI_XCB=ON`` CMake flag was present at build. This is the
     **default behaviour** on **Unix** *(not Apple)* systems.
 
 .. doxygenfunction:: TL_WindowSurfaceCreateXCB
 
 
-For X11 systems - via Xlib
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+For Xorg systems (via Xlib)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. important::
     Definitions for these functions is compiled **only if** the ``-DTHALLIUM_WSI_XLIB=ON`` CMake flag was present at build. This is the

diff --git a/include/thallium/core/wsi/cocoa_window_surface.h b/include/thallium/core/wsi/cocoa_window_surface.h
@@ -18,9 +18,9 @@
 /**
  * @brief Create a Thallium window surface from a Cocoa window handle.
  *
- * This function creates a window surface for Thallium functions, using a Cocoa window handle.
+ * This function creates a window surface for Thallium functions, using a Cocoa `NSWindow` window handle.
  *
- * @param window
+ * @param window The Cocoa `NSWindow` handle (as a void ptr)
  * @param debugger NULL or a debugger for function debugging
  * @return Resulting window surface for use in Thallium functions.
  */