summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxegineering <me@xegineering.eu>2024-12-08 18:31:56 +0100
committerxegineering <me@xegineering.eu>2024-12-08 18:34:11 +0100
commitf30e3668a6a65a8e5e43b3cc0b2030788b43857d (patch)
tree23e95ea7c9194884e2c88ff8ec9316c74f29ac3f
parentb76ac2daffb98fe7aea14385638150381cfb031b (diff)
downloadsoundbox-go-f30e3668a6a65a8e5e43b3cc0b2030788b43857d.tar
soundbox-go-f30e3668a6a65a8e5e43b3cc0b2030788b43857d.tar.zst
soundbox-go-f30e3668a6a65a8e5e43b3cc0b2030788b43857d.zip
Add examples to overview on generated API doc
This makes it easier for readers to find them.
-rw-r--r--CHANGELOG.md1
-rw-r--r--soundbox/example_pipewire_test.go (renamed from soundbox/pipewire_test.go)2
-rw-r--r--soundbox/example_url_test.go (renamed from soundbox/url_test.go)2
3 files changed, 3 insertions, 2 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index f7e58e8..35947be 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ adheres to [Semantic Versioning][semantic-versioning].
### Added
- streaming any audio content via PipeWire capture device on Linux
+- examples to overview section of Go API documentation
## [Version 0.1.5][0.1.5] - 2024-11-29
diff --git a/soundbox/pipewire_test.go b/soundbox/example_pipewire_test.go
index b857414..53864f3 100644
--- a/soundbox/pipewire_test.go
+++ b/soundbox/example_pipewire_test.go
@@ -9,7 +9,7 @@ import (
"xengineering.eu/soundbox-go/soundbox"
)
-func ExampleStreamPipewireContext() {
+func Example_pipewire() {
ctx, cancel := context.WithCancel(context.Background())
// all soundboxes are referenced by their MAC address
diff --git a/soundbox/url_test.go b/soundbox/example_url_test.go
index 41907ad..5c6a7c2 100644
--- a/soundbox/url_test.go
+++ b/soundbox/example_url_test.go
@@ -9,7 +9,7 @@ import (
"xengineering.eu/soundbox-go/soundbox"
)
-func ExampleStreamURLContext() {
+func Example_url() {
ctx, cancel := context.WithCancel(context.Background())
// all soundboxes are referenced by their MAC address