Browse Source

golint cleanup on cell.go

Shawn Milochik 10 years ago
parent
commit
43157e3625
1 changed files with 26 additions and 15 deletions
  1. 26 15
      cell.go

+ 26 - 15
cell.go

@@ -6,8 +6,10 @@ import (
 	"strconv"
 )
 
+// CellType is an int type for storing metadata about the data type in the cell.
 type CellType int
 
+// Known types for cell values.
 const (
 	CellTypeString CellType = iota
 	CellTypeFormula
@@ -36,15 +38,17 @@ type CellInterface interface {
 	FormattedValue() string
 }
 
+// NewCell creates a cell and adds it to a row.
 func NewCell(r *Row) *Cell {
 	return &Cell{style: NewStyle(), Row: r}
 }
 
+// Type returns the CellType of a cell. See CellType constants for more details.
 func (c *Cell) Type() CellType {
 	return c.cellType
 }
 
-// Set string
+// SetString sets the value of a cell to a string.
 func (c *Cell) SetString(s string) {
 	c.Value = s
 	c.formula = ""
@@ -56,13 +60,13 @@ func (c *Cell) String() string {
 	return c.FormattedValue()
 }
 
-// Set float
+// SetFloat sets the value of a cell to a float.
 func (c *Cell) SetFloat(n float64) {
 	c.SetFloatWithFormat(n, "0.00e+00")
 }
 
 /*
-	Set float with format. The followings are samples of format samples.
+	The following are samples of format samples.
 
 	* "0.00e+00"
 	* "0", "#,##0"
@@ -72,6 +76,9 @@ func (c *Cell) SetFloat(n float64) {
 	* "0%", "0.00%"
 	* "0.00e+00", "##0.0e+0"
 */
+
+// SetFloatWithFormat sets the value of a cell to a float and applies
+// formatting to the cell.
 func (c *Cell) SetFloatWithFormat(n float64, format string) {
 	// tmp value. final value is formatted by FormattedValue() method
 	c.Value = fmt.Sprintf("%e", n)
@@ -81,7 +88,7 @@ func (c *Cell) SetFloatWithFormat(n float64, format string) {
 	c.cellType = CellTypeNumeric
 }
 
-// Returns the value of cell as a number
+// Float returns the value of cell as a number.
 func (c *Cell) Float() (float64, error) {
 	f, err := strconv.ParseFloat(c.Value, 64)
 	if err != nil {
@@ -90,7 +97,7 @@ func (c *Cell) Float() (float64, error) {
 	return f, nil
 }
 
-// Set a 64-bit integer
+// SetInt64 sets a cell's value to a 64-bit integer.
 func (c *Cell) SetInt64(n int64) {
 	c.Value = fmt.Sprintf("%d", n)
 	c.numFmt = "0"
@@ -98,7 +105,7 @@ func (c *Cell) SetInt64(n int64) {
 	c.cellType = CellTypeNumeric
 }
 
-// Returns the value of cell as 64-bit integer
+// Int64 returns the value of cell as 64-bit integer.
 func (c *Cell) Int64() (int64, error) {
 	f, err := strconv.ParseInt(c.Value, 10, 64)
 	if err != nil {
@@ -107,7 +114,7 @@ func (c *Cell) Int64() (int64, error) {
 	return f, nil
 }
 
-// Set integer
+// SetInt sets a cell's value to an integer.
 func (c *Cell) SetInt(n int) {
 	c.Value = fmt.Sprintf("%d", n)
 	c.numFmt = "0"
@@ -115,7 +122,7 @@ func (c *Cell) SetInt(n int) {
 	c.cellType = CellTypeNumeric
 }
 
-// Returns the value of cell as integer
+// Int returns the value of cell as integer.
 // Has max 53 bits of precision
 // See: float64(int64(math.MaxInt))
 func (c *Cell) Int() (int, error) {
@@ -126,7 +133,7 @@ func (c *Cell) Int() (int, error) {
 	return int(f), nil
 }
 
-// Set boolean
+// SetBool sets a cell's value to a boolean.
 func (c *Cell) SetBool(b bool) {
 	if b {
 		c.Value = "1"
@@ -136,18 +143,20 @@ func (c *Cell) SetBool(b bool) {
 	c.cellType = CellTypeBool
 }
 
-// Get boolean
+// Bool returns a boolean from a cell's value.
+// TODO: Determine if the current return value is
+// appropriate for types other than CellTypeBool.
 func (c *Cell) Bool() bool {
 	return c.Value == "1"
 }
 
-// Set formula
+// SetFormula sets the format string for a cell.
 func (c *Cell) SetFormula(formula string) {
 	c.formula = formula
 	c.cellType = CellTypeFormula
 }
 
-// Returns formula
+// Formula returns the formula string for the cell.
 func (c *Cell) Formula() string {
 	return c.formula
 }
@@ -162,7 +171,7 @@ func (c *Cell) SetStyle(style *Style) {
 	c.style = style
 }
 
-// The number format string is returnable from a cell.
+// GetNumberFormat returns the number format string for a cell.
 func (c *Cell) GetNumberFormat() string {
 	return c.numFmt
 }
@@ -191,9 +200,11 @@ func (c *Cell) formatToInt(format string) string {
 	return fmt.Sprintf(format, int(f))
 }
 
-// Return the formatted version of the value.
+// FormattedValue returns the formatted version of the value.
+// If it's a string type, c.Value will just be returned. Otherwise,
+// it will attempt to apply Excel formatting to the value.
 func (c *Cell) FormattedValue() string {
-	var numberFormat string = c.GetNumberFormat()
+	var numberFormat = c.GetNumberFormat()
 	switch numberFormat {
 	case "general", "@":
 		return c.Value