Merge pull request #704 from openset/develop

Add: comment

Author: Shuo

internal/base/base.go

@@ -13,15 +13,16 @@ import (
 	"sync"
 )
 
-// CmdName
+// CmdName - base.CmdName
 const CmdName = "leetcode"
 
+// base var
 var (
 	Commands []*Command
 	Mutex    sync.Mutex
 )
 
-// Command
+// Command - base.Command
 type Command struct {
 	Run       func(cmd *Command, args []string)
 	UsageLine string
@@ -30,6 +31,7 @@ type Command struct {
 	Hidden    bool
 }
 
+// Name - base.Name
 func (c *Command) Name() string {
 	name := c.UsageLine
 	if i := strings.Index(name, " "); i > 0 {
@@ -38,16 +40,19 @@ func (c *Command) Name() string {
 	return name
 }
 
+// Usage - base.Usage
 func (c *Command) Usage() {
 	fmt.Printf("usage: %s %s\n\n", CmdName, c.UsageLine)
 	fmt.Printf("Run '%s help %s' for details.\n", CmdName, c.Name())
 }
 
+// UsageHelp - base.UsageHelp
 func (c *Command) UsageHelp() {
 	fmt.Printf("usage: %s %s\n\n", CmdName, c.UsageLine)
 	fmt.Println(c.Long)
 }
 
+// Usage - base.Usage
 func Usage() {
 	fmt.Printf("%s is a tool for managing leetcode source code.\n\n", CmdName)
 	fmt.Println("Usage:")
@@ -61,10 +66,11 @@ func Usage() {
 	fmt.Printf("\nUse \"%s help <command>\" for more information about a command.\n", CmdName)
 }
 
+// FilePutContents - base.FilePutContents
 func FilePutContents(filename string, data []byte) []byte {
 	ext := filepath.Ext(filename)
 	if strings.EqualFold(ext, ".json") {
-		data = JsonIndent(data)
+		data = JSONIndent(data)
 	}
 	if len(data) > 0 {
 		filename = getFilePath(filename)
@@ -74,7 +80,8 @@ func FilePutContents(filename string, data []byte) []byte {
 	return data
 }
 
-func JsonIndent(src []byte) []byte {
+// JSONIndent - base.JSONIndent
+func JSONIndent(src []byte) []byte {
 	if !json.Valid(src) {
 		return nil
 	}
@@ -93,12 +100,14 @@ func getFilePath(filename string) string {
 	return filename
 }
 
+// CheckErr - base.CheckErr
 func CheckErr(err error) {
 	if err != nil {
 		log.Fatalln(err)
 	}
 }
 
+// AuthInfo - base.AuthInfo
 func AuthInfo(cmd string) string {
 	format := "<!--|This file generated by command(leetcode %s); DO NOT EDIT.%s|-->\n"
 	format += "<!--+----------------------------------------------------------------------+-->\n"

internal/build/build.go

@@ -13,6 +13,7 @@ import (
 	"github.com/openset/leetcode/internal/version"
 )
 
+// CmdBuild - build.CmdBuild
 var CmdBuild = &base.Command{
 	Run:       runBuild,
 	UsageLine: "build",

internal/clean/clean.go

@@ -6,6 +6,7 @@ import (
 	"github.com/openset/leetcode/internal/leetcode"
 )
 
+// CmdClean - clean.CmdClean
 var CmdClean = &base.Command{
 	Run:       runClean,
 	UsageLine: "clean",

internal/client/client.go

@@ -25,6 +25,7 @@ func init() {
 	}
 }
 
+// Get - client.Get
 func Get(url string) []byte {
 	if resp, err := http.Get(url); err == nil {
 		defer resp.Body.Close()
@@ -35,7 +36,8 @@ func Get(url string) []byte {
 	return nil
 }
 
-func PostJson(url, jsonStr string) []byte {
+// PostJSON - client.PostJSON
+func PostJSON(url, jsonStr string) []byte {
 	if resp, err := http.Post(url, "application/json", strings.NewReader(jsonStr)); err == nil {
 		defer resp.Body.Close()
 		body, err := ioutil.ReadAll(resp.Body)

internal/description/description.go

@@ -9,6 +9,7 @@ import (
 	"github.com/openset/leetcode/internal/leetcode"
 )
 
+// CmdDescription - description.CmdDescription
 var CmdDescription = &base.Command{
 	Run:       runDescription,
 	UsageLine: "description",
@@ -29,7 +30,7 @@ func runDescription(cmd *base.Command, args []string) {
 	}
 	problems := leetcode.ProblemsAll()
 	for _, problem := range problems.StatStatusPairs {
-		fmt.Println(problem.Stat.FrontendQuestionId, "\t"+problem.Stat.QuestionTitle)
+		fmt.Println(problem.Stat.FrontendQuestionID, "\t"+problem.Stat.QuestionTitle)
 		wg.Add(1)
 		jobs <- problem
 	}

internal/help/help.go

@@ -7,6 +7,7 @@ import (
 	"github.com/openset/leetcode/internal/base"
 )
 
+// CmdHelp - help.CmdHelp
 var CmdHelp = &base.Command{
 	Run:       runHelp,
 	UsageLine: "help [command]",

internal/helper/helper.go

@@ -8,6 +8,7 @@ import (
 	"github.com/openset/leetcode/internal/base"
 )
 
+// CmdHelper - help.CmdHelper
 var CmdHelper = &base.Command{
 	Run:       runHelper,
 	UsageLine: "helper",

internal/kit/list_node.go

@@ -1,12 +1,12 @@
 package kit
 
-// Definition for singly-linked list.
+// ListNode - Definition for singly-linked list.
 type ListNode struct {
 	Val  int
 	Next *ListNode
 }
 
-// convert *ListNode to []int
+// ListNode2SliceInt - convert *ListNode to []int
 func ListNode2SliceInt(l *ListNode) (s []int) {
 	for l != nil {
 		s = append(s, l.Val)
@@ -15,7 +15,7 @@ func ListNode2SliceInt(l *ListNode) (s []int) {
 	return
 }
 
-// convert []int to *ListNode
+// SliceInt2ListNode - convert []int to *ListNode
 func SliceInt2ListNode(s []int) *ListNode {
 	l := &ListNode{}
 	t := l

internal/kit/tree_node.go

@@ -2,16 +2,17 @@ package kit
 
 import "math"
 
+// NULL null
 var NULL = math.MinInt32
 
-// Definition for a binary tree node.
+// TreeNode - Definition for a binary tree node.
 type TreeNode struct {
 	Val   int
 	Left  *TreeNode
 	Right *TreeNode
 }
 
-// convert []int to *TreeNode
+// SliceInt2TreeNode - convert []int to *TreeNode
 func SliceInt2TreeNode(s []int) *TreeNode {
 	l := len(s)
 	if l == 0 {
@@ -39,7 +40,7 @@ func SliceInt2TreeNode(s []int) *TreeNode {
 	return tree
 }
 
-// convert *TreeNode to []int
+// TreeNode2SliceInt - convert *TreeNode to []int
 func TreeNode2SliceInt(t *TreeNode) (s []int) {
 	if t != nil {
 		queue := []*TreeNode{t}

internal/leetcode/base.go

@@ -14,18 +14,19 @@ import (
 	"github.com/openset/leetcode/internal/client"
 )
 
+// leetcode var
 var (
 	authInfo        = base.AuthInfo
 	checkErr        = base.CheckErr
 	filePutContents = base.FilePutContents
-	jsonIndent      = base.JsonIndent
+	jsonIndent      = base.JSONIndent
 	LockStr         = " 🔒"
 	translationSet  = make(map[int]string)
 )
 
 func graphQLRequest(graphQL, jsonStr, filename string, days int, v interface{}) {
 	data := remember(filename, days, func() []byte {
-		return client.PostJson(graphQL, jsonStr)
+		return client.PostJSON(graphQL, jsonStr)
 	})
 	jsonDecode(data, &v)
 }
@@ -63,6 +64,7 @@ func getCachePath(f string) string {
 	return filepath.Join(dir, ".leetcode", f)
 }
 
+// Clean - leetcode.Clean
 func Clean() {
 	dir := getCachePath("")
 	err := os.RemoveAll(dir)