From ea97afb01ff6f8d991eb56072517ff487acc7b3d Mon Sep 17 00:00:00 2001
From: mappu <mappu04@gmail.com>
Date: Tue, 29 Nov 2016 19:40:08 +1300
Subject: [PATCH] move examples into a godoc-compatible Examples function

---
 Example_test.go    | 60 ++++++++++++++++++++++++++++++++++++++++++++++
 libnmdc_sample.go  | 39 ------------------------------
 libnmdc_sample2.go | 37 ----------------------------
 3 files changed, 60 insertions(+), 76 deletions(-)
 create mode 100644 Example_test.go
 delete mode 100644 libnmdc_sample.go
 delete mode 100644 libnmdc_sample2.go

diff --git a/Example_test.go b/Example_test.go
new file mode 100644
index 0000000..c136e8e
--- /dev/null
+++ b/Example_test.go
@@ -0,0 +1,60 @@
+package libnmdc
+
+import (
+	"fmt"
+)
+
+func ExampleConnect() {
+
+	opts := HubConnectionOptions{
+		Address: "127.0.0.1",
+		Self:    *NewUserInfo("slowpoke9"),
+	}
+	hub := opts.Connect()
+
+	for {
+		event := <-hub.OnEvent
+		switch event.EventType {
+		case EVENT_CONNECTION_STATE_CHANGED:
+			fmt.Printf("Connection -- %s (%s)\n", event.StateChange.Format(), event.Message)
+
+		case EVENT_PUBLIC:
+			fmt.Printf("Message from '%s': '%s'\n", event.Nick, event.Message)
+			if event.Message == "how are you" {
+				hub.SayPublic("good thanks!")
+			}
+
+		default:
+			fmt.Printf("%+v\n", event)
+
+		}
+	}
+}
+
+func ExampleConnectSync() {
+
+	cb := func(hub *HubConnection, event HubEvent) {
+		switch event.EventType {
+		case EVENT_CONNECTION_STATE_CHANGED:
+			fmt.Printf("Connection -- %s (%s)\n", event.StateChange.Format(), event.Message)
+
+		case EVENT_PUBLIC:
+			fmt.Printf("Message from '%s': '%s'\n", event.Nick, event.Message)
+			if event.Message == "how are you" {
+				hub.SayPublic("good thanks!")
+			}
+
+		default:
+			fmt.Printf("%+v\n", event)
+
+		}
+	}
+
+	opts := HubConnectionOptions{
+		Address:     "127.0.0.1",
+		Self:        *NewUserInfo("slowpoke9"),
+		OnEventSync: cb,
+	}
+
+	opts.ConnectSync() // blocking
+}
diff --git a/libnmdc_sample.go b/libnmdc_sample.go
deleted file mode 100644
index 6b46a84..0000000
--- a/libnmdc_sample.go
+++ /dev/null
@@ -1,39 +0,0 @@
-// +build ignore
-
-// This sample file demonstrates use of the libnmdc.go library. It's excluded
-//  when building the library package, but you can run it via `go run libnmdc_sample.go`.
-// This version demonstrates the channel API.
-
-package main
-
-import (
-	"fmt"
-	"libnmdc"
-)
-
-func main() {
-
-	opts := libnmdc.HubConnectionOptions{
-		Address: "127.0.0.1",
-		Self:    libnmdc.NewUserInfo("slowpoke9"),
-	}
-	hub := opts.Connect()
-
-	for {
-		event := <-hub.OnEvent
-		switch event.EventType {
-		case libnmdc.EVENT_CONNECTION_STATE_CHANGED:
-			fmt.Printf("Connection -- %s (%s)\n", event.StateChange.Format(), event.Message)
-
-		case libnmdc.EVENT_PUBLIC:
-			fmt.Printf("Message from '%s': '%s'\n", event.Nick, event.Message)
-			if event.Message == "how are you" {
-				hub.SayPublic("good thanks!")
-			}
-
-		default:
-			fmt.Printf("%+v\n", event)
-
-		}
-	}
-}
diff --git a/libnmdc_sample2.go b/libnmdc_sample2.go
deleted file mode 100644
index 4022e8f..0000000
--- a/libnmdc_sample2.go
+++ /dev/null
@@ -1,37 +0,0 @@
-// +build ignore
-
-// This sample file demonstrates use of the libnmdc.go library. It's excluded
-//  when building the library package, but you can run it via `go run libnmdc_sample.go`.
-// This version demonstrates the sync API.
-
-package main
-
-import (
-	"fmt"
-	"libnmdc"
-)
-
-func main() {
-
-	libnmdc.HubConnectionOptions{
-		Address: "127.0.0.1",
-		Self:    libnmdc.NewUserInfo("slowpoke9"),
-
-		OnEventSync: func(ev libnmdc.HubEvent) {
-			switch event.EventType {
-			case libnmdc.EVENT_CONNECTION_STATE_CHANGED:
-				fmt.Printf("Connection -- %s (%s)\n", event.StateChange.Format(), event.Message)
-
-			case libnmdc.EVENT_PUBLIC:
-				fmt.Printf("Message from '%s': '%s'\n", event.Nick, event.Message)
-				if event.Message == "how are you" {
-					hub.SayPublic("good thanks!")
-				}
-
-			default:
-				fmt.Printf("%+v\n", event)
-
-			}
-		},
-	}.Connect()
-}