mostly comment fixes

Author: JohnCGriffin

overflow.go

@@ -15,10 +15,9 @@
 // Add, Sub, Mul, Div are for int.  Add64, Add32, etc. are specifically sized.
 //
 // If anybody wishes an unsigned version, submit a pull request for code and new tests.
-
 package overflow
 
-//go:generate ./overflow_template.sh 
+//go:generate ./overflow_template.sh
 
 import "math"
 
@@ -27,7 +26,6 @@ func _is64Bit() bool {
 	return ((maxU32 << 1) >> 1) == maxU32
 }
 
-
 /********** PARTIAL TEST COVERAGE FROM HERE DOWN *************
 
 The only way that I could see to do this is a combination of
@@ -40,6 +38,7 @@ So, FEEL FREE to carefully review the code visually.
 
 // Unspecified size, i.e. normal signed int
 
+// Add sums two ints, returning the result and a boolean status.
 func Add(a, b int) (int, bool) {
 	if _is64Bit() {
 		r64, ok := Add64(int64(a), int64(b))
@@ -49,6 +48,7 @@ func Add(a, b int) (int, bool) {
 	return int(r32), ok
 }
 
+// Sub returns the difference of two ints and a boolean status.
 func Sub(a, b int) (int, bool) {
 	if _is64Bit() {
 		r64, ok := Sub64(int64(a), int64(b))
@@ -58,6 +58,7 @@ func Sub(a, b int) (int, bool) {
 	return int(r32), ok
 }
 
+// Mul returns the product of two ints and a boolean status.
 func Mul(a, b int) (int, bool) {
 	if _is64Bit() {
 		r64, ok := Mul64(int64(a), int64(b))
@@ -67,6 +68,7 @@ func Mul(a, b int) (int, bool) {
 	return int(r32), ok
 }
 
+// Div returns the quotient of two ints and a boolean status
 func Div(a, b int) (int, bool) {
 	if _is64Bit() {
 		r64, ok := Div64(int64(a), int64(b))
@@ -76,6 +78,7 @@ func Div(a, b int) (int, bool) {
 	return int(r32), ok
 }
 
+// Quotient returns the quotient, remainder and status of two ints
 func Quotient(a, b int) (int, int, bool) {
 	if _is64Bit() {
 		q64, r64, ok := Quotient64(int64(a), int64(b))
@@ -87,6 +90,7 @@ func Quotient(a, b int) (int, int, bool) {
 
 /************* Panic versions for int ****************/
 
+// Addp returns the sum of two ints, panicking on overflow
 func Addp(a, b int) int {
 	r, ok := Add(a, b)
 	if !ok {
@@ -95,6 +99,7 @@ func Addp(a, b int) int {
 	return r
 }
 
+// Subp returns the difference of two ints, panicking on overflow.
 func Subp(a, b int) int {
 	r, ok := Sub(a, b)
 	if !ok {
@@ -103,6 +108,7 @@ func Subp(a, b int) int {
 	return r
 }
 
+// Mulp returns the product of two ints, panicking on overflow.
 func Mulp(a, b int) int {
 	r, ok := Mul(a, b)
 	if !ok {
@@ -111,6 +117,7 @@ func Mulp(a, b int) int {
 	return r
 }
 
+// Divp returns the quotient of two ints, panicking on overflow.
 func Divp(a, b int) int {
 	r, ok := Div(a, b)
 	if !ok {

overflow_impl.go

@@ -62,7 +62,7 @@ func Mul8(a, b int8) (int8, bool) {
 }
 
 // Mul8p is the unchecked panicing version of Mul8
-func Mulp8(a, b int8) int8 {
+func Mul8p(a, b int8) int8 {
         r, ok := Mul8(a, b)
         if !ok {
                 panic("multiplication overflow")
@@ -80,7 +80,7 @@ func Div8(a, b int8) (int8, bool) {
 }
 
 // Div8p is the unchecked panicing version of Div8
-func Divp8(a, b int8) int8 {
+func Div8p(a, b int8) int8 {
         r, ok := Div8(a, b)
         if !ok {
                 panic("division failure")
@@ -157,7 +157,7 @@ func Mul16(a, b int16) (int16, bool) {
 }
 
 // Mul16p is the unchecked panicing version of Mul16
-func Mulp16(a, b int16) int16 {
+func Mul16p(a, b int16) int16 {
         r, ok := Mul16(a, b)
         if !ok {
                 panic("multiplication overflow")
@@ -175,7 +175,7 @@ func Div16(a, b int16) (int16, bool) {
 }
 
 // Div16p is the unchecked panicing version of Div16
-func Divp16(a, b int16) int16 {
+func Div16p(a, b int16) int16 {
         r, ok := Div16(a, b)
         if !ok {
                 panic("division failure")
@@ -252,7 +252,7 @@ func Mul32(a, b int32) (int32, bool) {
 }
 
 // Mul32p is the unchecked panicing version of Mul32
-func Mulp32(a, b int32) int32 {
+func Mul32p(a, b int32) int32 {
         r, ok := Mul32(a, b)
         if !ok {
                 panic("multiplication overflow")
@@ -270,7 +270,7 @@ func Div32(a, b int32) (int32, bool) {
 }
 
 // Div32p is the unchecked panicing version of Div32
-func Divp32(a, b int32) int32 {
+func Div32p(a, b int32) int32 {
         r, ok := Div32(a, b)
         if !ok {
                 panic("division failure")
@@ -347,7 +347,7 @@ func Mul64(a, b int64) (int64, bool) {
 }
 
 // Mul64p is the unchecked panicing version of Mul64
-func Mulp64(a, b int64) int64 {
+func Mul64p(a, b int64) int64 {
         r, ok := Mul64(a, b)
         if !ok {
                 panic("multiplication overflow")
@@ -365,7 +365,7 @@ func Div64(a, b int64) (int64, bool) {
 }
 
 // Div64p is the unchecked panicing version of Div64
-func Divp64(a, b int64) int64 {
+func Div64p(a, b int64) int64 {
         r, ok := Div64(a, b)
         if !ok {
                 panic("division failure")

overflow_template.sh

@@ -70,7 +70,7 @@ func Mul${SIZE}(a, b int${SIZE}) (int${SIZE}, bool) {
 }
 
 // Mul${SIZE}p is the unchecked panicing version of Mul${SIZE}
-func Mulp${SIZE}(a, b int${SIZE}) int${SIZE} {
+func Mul${SIZE}p(a, b int${SIZE}) int${SIZE} {
         r, ok := Mul${SIZE}(a, b)
         if !ok {
                 panic(\"multiplication overflow\")
@@ -88,7 +88,7 @@ func Div${SIZE}(a, b int${SIZE}) (int${SIZE}, bool) {
 }
 
 // Div${SIZE}p is the unchecked panicing version of Div${SIZE}
-func Divp${SIZE}(a, b int${SIZE}) int${SIZE} {
+func Div${SIZE}p(a, b int${SIZE}) int${SIZE} {
         r, ok := Div${SIZE}(a, b)
         if !ok {
                 panic(\"division failure\")