Improve comments (#83)

Add a trailing dot at the end of comments on top of declarations

Author: Paolo Calao

arduino/commander.go

@@ -22,7 +22,7 @@ import (
 )
 
 // Commander of arduino package allows to call
-// the arduino-cli commands in a programmatic way
+// the arduino-cli commands in a programmatic way.
 type Commander interface {
 	BoardList() ([]*rpc.DetectedPort, error)
 	UploadBin(fqbn, bin, port string) error

arduino/dir.go

@@ -27,7 +27,7 @@ import (
 	"github.com/arduino/go-win32-utils"
 )
 
-// DataDir returns the Arduino default data directory (arduino15)
+// DataDir returns the Arduino default data directory (arduino15).
 func DataDir() (*paths.Path, error) {
 	userHomeDir, err := os.UserHomeDir()
 	if err != nil {

arduino/grpc/client.go

@@ -43,7 +43,7 @@ type client struct {
 // NewClient instantiates and returns a new grpc client that allows to
 // programmatically call arduino-cli commands.
 // It exploits the grpc interface of the arduino-cli.
-// It returns: the client instance, a callback to close the client and an error
+// It returns: the client instance, a callback to close the client and an error.
 func NewClient() (arduino.Commander, func() error, error) {
 	// Establish a connection with the gRPC server, started with the command:
 	// arduino-cli daemon

cli/version/version.go

@@ -25,7 +25,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// NewCommand created a new `version` command
+// NewCommand creates a new `version` command.
 func NewCommand() *cobra.Command {
 	return &cobra.Command{
 		Use:     "version",

command/dashboard/create.go

@@ -32,7 +32,7 @@ type CreateParams struct {
 	Template string            // Path of the template file
 }
 
-// Create allows to create a new dashboard
+// Create allows to create a new dashboard.
 func Create(params *CreateParams) (*DashboardInfo, error) {
 	conf, err := config.Retrieve()
 	if err != nil {

command/device/board.go

@@ -39,7 +39,7 @@ var (
 	}
 )
 
-// board contains details of a physical arduino board
+// board contains details of a physical arduino board.
 type board struct {
 	fqbn   string
 	serial string
@@ -48,7 +48,7 @@ type board struct {
 }
 
 // isCrypto checks if the board is a valid arduino board with a
-// supported crypto-chip
+// supported crypto-chip.
 func (b *board) isCrypto() bool {
 	for _, f := range cryptoFQBN {
 		if b.fqbn == f {
@@ -58,7 +58,7 @@ func (b *board) isCrypto() bool {
 	return false
 }
 
-// isCrypto checks if the board is a valid LoRa arduino board
+// isLora checks if the board is a valid LoRa arduino board.
 func (b *board) isLora() bool {
 	for _, f := range loraFQBN {
 		if b.fqbn == f {
@@ -94,8 +94,8 @@ func boardFromPorts(ports []*rpc.DetectedPort, params *CreateParams) *board {
 // - if the port parameter does not match the actual port address.
 // - if the the detected port does not contain any board.
 // It returns:
-// true -> to skip the port
-// false -> to keep the port
+// true -> to skip the port.
+// false -> to keep the port.
 func portFilter(port *rpc.DetectedPort, params *CreateParams) bool {
 	if len(port.Boards) == 0 {
 		return true

command/device/createlora.go

@@ -40,7 +40,7 @@ const (
 	serialEUIBaudrate = 9600
 
 	// dev-eui is an IEEE EUI64 address, so it must have length of 8 bytes.
-	// It's retrieved as hexadecimal string, thus 16 chars are expected
+	// It's retrieved as hexadecimal string, thus 16 chars are expected.
 	deveuiLength = 16
 )
 

command/device/provision.go

@@ -64,7 +64,7 @@ func downloadProvisioningFile(fqbn string) (string, error) {
 }
 
 // provision is responsible for running the provisioning
-// procedures for boards with crypto-chip
+// procedures for boards with crypto-chip.
 type provision struct {
 	arduino.Commander
 	iot.Client
@@ -73,7 +73,7 @@ type provision struct {
 	id    string
 }
 
-// run provisioning procedure for boards with crypto-chip
+// run provisioning procedure for boards with crypto-chip.
 func (p provision) run() error {
 	bin, err := downloadProvisioningFile(p.board.fqbn)
 	if err != nil {

command/ota/massupload.go

@@ -43,7 +43,7 @@ type MassUploadParams struct {
 	FQBN      string
 }
 
-// Result of an ota upload on a device
+// Result of an ota upload on a device.
 type Result struct {
 	ID  string
 	Err error

command/tag/create.go

@@ -33,7 +33,7 @@ type CreateTagsParams struct {
 }
 
 // CreateTags allows to create or overwrite tags
-// on a resource of Arduino IoT Cloud
+// on a resource of Arduino IoT Cloud.
 func CreateTags(params *CreateTagsParams) error {
 	conf, err := config.Retrieve()
 	if err != nil {