From 3a0de7ba059b2fc45c18248ce77a5ba5f01a5b74 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dominik=20Madar=C3=A1sz?= <zaklaus@outlook.com>
Date: Tue, 28 Nov 2023 14:49:43 +0100
Subject: [PATCH] improve docs

---
 engine/joint/v4k.h     | 36 ++++++++++++++++++------------------
 engine/split/v4k_gui.h | 36 ++++++++++++++++++------------------
 engine/v4k.h           | 36 ++++++++++++++++++------------------
 3 files changed, 54 insertions(+), 54 deletions(-)

diff --git a/engine/joint/v4k.h b/engine/joint/v4k.h
index 864df6e..e112a1f 100644
--- a/engine/joint/v4k.h
+++ b/engine/joint/v4k.h
@@ -18146,29 +18146,29 @@ API void    gui_popskin();
 // default renderers
 
 /// skinned
-/* The skinning engine depends on an Aseprite asset with slices set up.
-   While you can specify your own skins for various GUI widgets, some
-   skin variants are hardcoded and expected to be present in your asset:
-
-   gui_panel():
-    - "panel" (overridable)
-   gui_button():
-    - "button" (base overridable)
-      - "_hover" (ex. "scarybtn_hover")
-      - "_press"
-   gui_rect():
-    - no defaults, always pass your own skin/slice name
-   gui_slider():
-    - "slider" (overridable)
-    - "slider_cursor" (partially overridable, ex. "bigslider_cursor")
-      - "_hover" (ex. "slider_cursor_hover")
-      - "_press"
-*/
 typedef struct skinned_t {
     atlas_t atlas;
     float scale;
 } skinned_t;
 
+// The skinning engine depends on an Aseprite asset with slices set up.
+//   While you can specify your own skins for various GUI widgets, some
+//   skin variants are hardcoded and expected to be present in your asset:
+//
+//   gui_panel():
+//    - "panel" (overridable)
+//   gui_button():
+//    - "button" (base overridable)
+//      - "_hover" (ex. "scarybtn_hover")
+//      - "_press"
+//   gui_rect():
+//    - no defaults, always pass your own skin/slice name
+//   gui_slider():
+//    - "slider" (overridable)
+//    - "slider_cursor" (partially overridable, ex. "bigslider_cursor")
+//      - "_hover" (ex. "slider_cursor_hover")
+//      - "_press"
+//
 API guiskin_t gui_skinned(const char *asefile, float scale);
 #line 0
 
diff --git a/engine/split/v4k_gui.h b/engine/split/v4k_gui.h
index bed0267..9d8cecd 100644
--- a/engine/split/v4k_gui.h
+++ b/engine/split/v4k_gui.h
@@ -31,27 +31,27 @@ API void    gui_popskin();
 // default renderers
 
 /// skinned
-/* The skinning engine depends on an Aseprite asset with slices set up.
-   While you can specify your own skins for various GUI widgets, some
-   skin variants are hardcoded and expected to be present in your asset:
-
-   gui_panel():
-    - "panel" (overridable)
-   gui_button():
-    - "button" (base overridable)
-      - "_hover" (ex. "scarybtn_hover")
-      - "_press"
-   gui_rect():
-    - no defaults, always pass your own skin/slice name
-   gui_slider():
-    - "slider" (overridable)
-    - "slider_cursor" (partially overridable, ex. "bigslider_cursor")
-      - "_hover" (ex. "slider_cursor_hover")
-      - "_press"
-*/
 typedef struct skinned_t {
     atlas_t atlas;
     float scale;
 } skinned_t;
 
+// The skinning engine depends on an Aseprite asset with slices set up.
+//   While you can specify your own skins for various GUI widgets, some
+//   skin variants are hardcoded and expected to be present in your asset:
+//
+//   gui_panel():
+//    - "panel" (overridable)
+//   gui_button():
+//    - "button" (base overridable)
+//      - "_hover" (ex. "scarybtn_hover")
+//      - "_press"
+//   gui_rect():
+//    - no defaults, always pass your own skin/slice name
+//   gui_slider():
+//    - "slider" (overridable)
+//    - "slider_cursor" (partially overridable, ex. "bigslider_cursor")
+//      - "_hover" (ex. "slider_cursor_hover")
+//      - "_press"
+//
 API guiskin_t gui_skinned(const char *asefile, float scale);
diff --git a/engine/v4k.h b/engine/v4k.h
index b2edc05..39863b4 100644
--- a/engine/v4k.h
+++ b/engine/v4k.h
@@ -4213,29 +4213,29 @@ API void    gui_popskin();
 // default renderers
 
 /// skinned
-/* The skinning engine depends on an Aseprite asset with slices set up.
-   While you can specify your own skins for various GUI widgets, some
-   skin variants are hardcoded and expected to be present in your asset:
-
-   gui_panel():
-    - "panel" (overridable)
-   gui_button():
-    - "button" (base overridable)
-      - "_hover" (ex. "scarybtn_hover")
-      - "_press"
-   gui_rect():
-    - no defaults, always pass your own skin/slice name
-   gui_slider():
-    - "slider" (overridable)
-    - "slider_cursor" (partially overridable, ex. "bigslider_cursor")
-      - "_hover" (ex. "slider_cursor_hover")
-      - "_press"
-*/
 typedef struct skinned_t {
     atlas_t atlas;
     float scale;
 } skinned_t;
 
+// The skinning engine depends on an Aseprite asset with slices set up.
+//   While you can specify your own skins for various GUI widgets, some
+//   skin variants are hardcoded and expected to be present in your asset:
+//
+//   gui_panel():
+//    - "panel" (overridable)
+//   gui_button():
+//    - "button" (base overridable)
+//      - "_hover" (ex. "scarybtn_hover")
+//      - "_press"
+//   gui_rect():
+//    - no defaults, always pass your own skin/slice name
+//   gui_slider():
+//    - "slider" (overridable)
+//    - "slider_cursor" (partially overridable, ex. "bigslider_cursor")
+//      - "_hover" (ex. "slider_cursor_hover")
+//      - "_press"
+//
 API guiskin_t gui_skinned(const char *asefile, float scale);
 #line 0