docs: add examples for Go Docs (#9)

shoenig · May 5, 2023 · 41fe74c · 41fe74c
1 parent 76ca6b6
commit 41fe74c
Showing 1 changed file with 55 additions and 0 deletions.
diff --git a/examples_test.go b/examples_test.go
@@ -0,0 +1,55 @@
+package m1cpu
+
+import (
+	"fmt"
+)
+
+func ExampleIsAppleSilicon() {
+	value := IsAppleSilicon()
+	fmt.Println(value)
+}
+
+func ExampleModelName() {
+	value := ModelName()
+	fmt.Println(value)
+}
+
+func ExamplePCoreHz() {
+	value := PCoreHz()
+	fmt.Println(value)
+}
+
+func ExampleECoreHz() {
+	value := ECoreHz()
+	fmt.Println(value)
+}
+
+func ExamplePCoreGHz() {
+	value := PCoreGHz()
+	fmt.Println(value)
+}
+
+func ExampleECoreGHz() {
+	value := ECoreGHz()
+	fmt.Println(value)
+}
+
+func ExamplePCoreCount() {
+	value := PCoreCount()
+	fmt.Println(value)
+}
+
+func ExampleECoreCount() {
+	value := ECoreCount()
+	fmt.Println(value)
+}
+
+func ExamplePCoreCache() {
+	l1inst, l1data, l2 := PCoreCache()
+	fmt.Println(l1inst, l1data, l2)
+}
+
+func ExampleECoreCache() {
+	l1inst, l1data, l2 := ECoreCache()
+	fmt.Println(l1inst, l1data, l2)
+}