From 3a33536c808ddfd4846716a1e177c42d09b01f31 Mon Sep 17 00:00:00 2001
From: Tevin Zhang <mail2tevin@gmail.com>
Date: Thu, 16 Jul 2020 14:07:17 +0800
Subject: [PATCH] Refine comments

---
 bool.go | 24 +++++++++++-------------
 1 file changed, 11 insertions(+), 13 deletions(-)

diff --git a/bool.go b/bool.go
index 2205f9b..e894dab 100644
--- a/bool.go
+++ b/bool.go
@@ -4,12 +4,12 @@ package abool
 
 import "sync/atomic"
 
-// New creates an AtomicBool with default to false
+// New creates an AtomicBool with default set to false.
 func New() *AtomicBool {
 	return new(AtomicBool)
 }
 
-// NewBool creates an AtomicBool with given default value
+// NewBool creates an AtomicBool with given default value.
 func NewBool(ok bool) *AtomicBool {
 	ab := New()
 	if ok {
@@ -18,24 +18,22 @@ func NewBool(ok bool) *AtomicBool {
 	return ab
 }
 
-// AtomicBool is an atomic Boolean
-// Its methods are all atomic, thus safe to be called by
-// multiple goroutines simultaneously
-// Note: When embedding into a struct, one should always use
-// *AtomicBool to avoid copy
+// AtomicBool is an atomic Boolean.
+// Its methods are all atomic, thus safe to be called by multiple goroutines simultaneously.
+// Note: When embedding into a struct one should always use *AtomicBool to avoid copy.
 type AtomicBool int32
 
-// Set sets the Boolean to true
+// Set sets the Boolean to true.
 func (ab *AtomicBool) Set() {
 	atomic.StoreInt32((*int32)(ab), 1)
 }
 
-// UnSet sets the Boolean to false
+// UnSet sets the Boolean to false.
 func (ab *AtomicBool) UnSet() {
 	atomic.StoreInt32((*int32)(ab), 0)
 }
 
-// IsSet returns whether the Boolean is true
+// IsSet returns whether the Boolean is true.
 func (ab *AtomicBool) IsSet() bool {
 	return atomic.LoadInt32((*int32)(ab))&1 == 1
 }
@@ -49,13 +47,13 @@ func (ab *AtomicBool) SetTo(yes bool) {
 	}
 }
 
-// Toggle inverts the boolean then returns the value before inverting.
+// Toggle inverts the Boolean then returns the value before inverting.
 func (ab *AtomicBool) Toggle() bool {
 	return atomic.AddInt32((*int32)(ab), 1)&1 == 0
 }
 
-// SetToIf sets the Boolean to new only if the Boolean matches the old
-// Returns whether the set was done
+// SetToIf sets the Boolean to new only if the Boolean matches the old.
+// Returns whether the set was done.
 func (ab *AtomicBool) SetToIf(old, new bool) (set bool) {
 	var o, n int32
 	if old {