feat: add doc for interface function. Close #23

core/browser.go

@@ -18,9 +18,16 @@ const (
 )
 
 type Browser interface {
+	// InitSecretKey is init chrome secret key, firefox's key always empty
 	InitSecretKey() error
+
+	// GetName return browser name
 	GetName() string
+
+	// GetSecretKey return browser secret key
 	GetSecretKey() []byte
+
+	// GetAllItems, default return all of items(password|bookmark|cookie|history)
 	GetAllItems(itemName string) ([]common.Item, error)
 }
 

core/common/parse.go

@@ -19,10 +19,19 @@ import (
 )
 
 type Item interface {
+	// ChromeParse parse chrome items, Password and Cookie need secret key
 	ChromeParse(key []byte) error
+
+	// FirefoxParse parse firefox items
 	FirefoxParse() error
+
+	// OutPut with json or csv
 	OutPut(format, browser, dir string) error
+
+	// Copy item file to local path
 	CopyItem() error
+
+	// Release item file
 	Release() error
 }
 

core/decrypt/decrypt_darwin.go

@@ -93,7 +93,7 @@ func decryptPBE(globalSalt, masterPwd, entrySalt, encrypted []byte) ([]byte, err
 	//byte[] k1;
 	//byte[] tk;
 	//byte[] k2;
-	//byte[] k; // final value conytaining key and iv
+	//byte[] k; // final value containing key and iv
 	glmp := append(globalSalt, masterPwd...)
 	hp := sha1.Sum(glmp)
 	s := append(hp[:], entrySalt...)