Updates to documentation

LICENSE

@@ -1,5 +1,5 @@
 
-Copyright (c) 2014, Cristian Maglie.
+Copyright (c) 2014-2016, Cristian Maglie.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

doc.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

example_getportlist_test.go

@@ -0,0 +1,26 @@
+//
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+//
+
+package serial_test
+
+import "fmt"
+import "log"
+import "go.bug.st/serial"
+
+func ExampleGetPortsList() {
+	ports, err := serial.GetPortsList()
+	if err != nil {
+		log.Fatal(err)
+	}
+	if len(ports) == 0 {
+		fmt.Println("No serial ports found!")
+	} else {
+		for _, port := range ports {
+			fmt.Printf("Found port: %v\n", port)
+		}
+	}
+}
+

example_serialport_test.go

@@ -0,0 +1,29 @@
+//
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+//
+
+package serial_test
+
+import "fmt"
+import "log"
+import "go.bug.st/serial"
+
+func ExampleSerialPort_SetMode() {
+	port, err := serial.OpenPort("/dev/ttyACM0", &serial.Mode{})
+	if err != nil {
+		log.Fatal(err)
+	}
+	mode := &serial.Mode{
+		BaudRate: 9600,
+		Parity:   serial.PARITY_NONE,
+		DataBits: 8,
+		StopBits: serial.STOPBITS_ONE,
+	}
+	if err := port.SetMode(mode); err != nil {
+		log.Fatal(err)
+	}
+	fmt.Println("Port set to 9600 N81")
+}
+

example_test.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2015 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
@@ -10,38 +10,11 @@ import "fmt"
 import "log"
 import "go.bug.st/serial"
 
-func ExampleGetPortsList() {
+// This example prints the list of serial ports and use the first one
-	ports, err := serial.GetPortsList()
+// to send a string "10,20,30" and prints the response on the screen.
-	if err != nil {
+func Example_sendAndReceive() {
-		log.Fatal(err)
-	}
-	if len(ports) == 0 {
-		fmt.Println("No serial ports found!")
-	} else {
-		for _, port := range ports {
-			fmt.Printf("Found port: %v\n", port)
-		}
-	}
-}
 
-func ExampleSetMode() {
+	// Retrieve the port list
-	port, err := serial.OpenPort("/dev/ttyACM0", &serial.Mode{})
-	if err != nil {
-		log.Fatal(err)
-	}
-	mode := &serial.Mode{
-		BaudRate: 9600,
-		Parity:   serial.PARITY_NONE,
-		DataBits: 8,
-		StopBits: serial.STOPBITS_ONE,
-	}
-	if err := port.SetMode(mode); err != nil {
-		log.Fatal(err)
-	}
-	fmt.Println("Port set to 9600 N81")
-}
-
-func ExampleFullCommunication() {
 	ports, err := serial.GetPortsList()
 	if err != nil {
 		log.Fatal(err)
@@ -50,10 +23,12 @@ func ExampleFullCommunication() {
 		log.Fatal("No serial ports found!")
 	}
 
+	// Print the list of detected ports
 	for _, port := range ports {
 		fmt.Printf("Found port: %v\n", port)
 	}
 
+	// Open the first serial port detected at 9600bps N81
 	mode := &serial.Mode{
 		BaudRate: 9600,
 		Parity:   serial.PARITY_NONE,
@@ -64,12 +39,15 @@ func ExampleFullCommunication() {
 	if err != nil {
 		log.Fatal(err)
 	}
+
+	// Send the string "10,20,30\n\r" to the serial port
 	n, err := port.Write([]byte("10,20,30\n\r"))
 	if err != nil {
 		log.Fatal(err)
 	}
 	fmt.Printf("Sent %v bytes\n", n)
 
+	// Read and print the response
 	buff := make([]byte, 100)
 	for {
 		// Reads up to 100 bytes
@@ -86,4 +64,3 @@ func ExampleFullCommunication() {
 	}
 }
 
-// vi:ts=2

serial.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
@@ -73,4 +73,3 @@ func (e SerialPortError) Code() int {
 	return e.code
 }
 
-// vi:ts=2

serial_darwin.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

serial_darwin_386.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

serial_darwin_amd64.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

serial_linux.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

serial_unix.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

serial_windows.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
@@ -268,4 +268,3 @@ func OpenPort(portName string, mode *Mode) (*SerialPort, error) {
 	return port, nil
 }
 
-// vi:ts=2

syscall_darwin.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

syscall_linux.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Cristian Maglie. All rights reserved.
+// Copyright 2014-2016 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //