From f30e3668a6a65a8e5e43b3cc0b2030788b43857d Mon Sep 17 00:00:00 2001
From: xegineering <me@xegineering.eu>
Date: Sun, 8 Dec 2024 18:31:56 +0100
Subject: Add examples to overview on generated API doc

This makes it easier for readers to find them.
---
 soundbox/example_pipewire_test.go | 35 +++++++++++++++++++++++++++++++++++
 soundbox/example_url_test.go      | 38 ++++++++++++++++++++++++++++++++++++++
 soundbox/pipewire_test.go         | 35 -----------------------------------
 soundbox/url_test.go              | 38 --------------------------------------
 4 files changed, 73 insertions(+), 73 deletions(-)
 create mode 100644 soundbox/example_pipewire_test.go
 create mode 100644 soundbox/example_url_test.go
 delete mode 100644 soundbox/pipewire_test.go
 delete mode 100644 soundbox/url_test.go

(limited to 'soundbox')

diff --git a/soundbox/example_pipewire_test.go b/soundbox/example_pipewire_test.go
new file mode 100644
index 0000000..53864f3
--- /dev/null
+++ b/soundbox/example_pipewire_test.go
@@ -0,0 +1,35 @@
+package soundbox_test
+
+import (
+	"context"
+	"log"
+	"net"
+	"time"
+
+	"xengineering.eu/soundbox-go/soundbox"
+)
+
+func Example_pipewire() {
+	ctx, cancel := context.WithCancel(context.Background())
+
+	// all soundboxes are referenced by their MAC address
+	soundboxes := []net.HardwareAddr{
+		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x01},
+		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x02},
+		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x03},
+	}
+
+	// start streaming
+	go func() {
+		err := soundbox.StreamPipewireContext(ctx, soundboxes)
+		if err != nil {
+			log.Fatal(err)
+		}
+	}()
+
+	// let it play for some time
+	time.Sleep(time.Minute)
+
+	// stop it
+	cancel()
+}
diff --git a/soundbox/example_url_test.go b/soundbox/example_url_test.go
new file mode 100644
index 0000000..5c6a7c2
--- /dev/null
+++ b/soundbox/example_url_test.go
@@ -0,0 +1,38 @@
+package soundbox_test
+
+import (
+	"context"
+	"log"
+	"net"
+	"time"
+
+	"xengineering.eu/soundbox-go/soundbox"
+)
+
+func Example_url() {
+	ctx, cancel := context.WithCancel(context.Background())
+
+	// all soundboxes are referenced by their MAC address
+	soundboxes := []net.HardwareAddr{
+		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x01},
+		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x02},
+		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x03},
+	}
+
+	// currently only web radio is supported
+	url := "https://example.org/radio.mp3"
+
+	// start streaming
+	go func() {
+		err := soundbox.StreamURLContext(ctx, url, soundboxes)
+		if err != nil {
+			log.Fatal(err)
+		}
+	}()
+
+	// let it play for some time
+	time.Sleep(time.Minute)
+
+	// stop it
+	cancel()
+}
diff --git a/soundbox/pipewire_test.go b/soundbox/pipewire_test.go
deleted file mode 100644
index b857414..0000000
--- a/soundbox/pipewire_test.go
+++ /dev/null
@@ -1,35 +0,0 @@
-package soundbox_test
-
-import (
-	"context"
-	"log"
-	"net"
-	"time"
-
-	"xengineering.eu/soundbox-go/soundbox"
-)
-
-func ExampleStreamPipewireContext() {
-	ctx, cancel := context.WithCancel(context.Background())
-
-	// all soundboxes are referenced by their MAC address
-	soundboxes := []net.HardwareAddr{
-		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x01},
-		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x02},
-		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x03},
-	}
-
-	// start streaming
-	go func() {
-		err := soundbox.StreamPipewireContext(ctx, soundboxes)
-		if err != nil {
-			log.Fatal(err)
-		}
-	}()
-
-	// let it play for some time
-	time.Sleep(time.Minute)
-
-	// stop it
-	cancel()
-}
diff --git a/soundbox/url_test.go b/soundbox/url_test.go
deleted file mode 100644
index 41907ad..0000000
--- a/soundbox/url_test.go
+++ /dev/null
@@ -1,38 +0,0 @@
-package soundbox_test
-
-import (
-	"context"
-	"log"
-	"net"
-	"time"
-
-	"xengineering.eu/soundbox-go/soundbox"
-)
-
-func ExampleStreamURLContext() {
-	ctx, cancel := context.WithCancel(context.Background())
-
-	// all soundboxes are referenced by their MAC address
-	soundboxes := []net.HardwareAddr{
-		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x01},
-		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x02},
-		{0x00, 0x00, 0x5E, 0x00, 0x53, 0x03},
-	}
-
-	// currently only web radio is supported
-	url := "https://example.org/radio.mp3"
-
-	// start streaming
-	go func() {
-		err := soundbox.StreamURLContext(ctx, url, soundboxes)
-		if err != nil {
-			log.Fatal(err)
-		}
-	}()
-
-	// let it play for some time
-	time.Sleep(time.Minute)
-
-	// stop it
-	cancel()
-}
-- 
cgit v1.2.3-70-g09d2