Fix Go Report Card Issues functions models #100

models/user.go

@@ -576,6 +576,7 @@ func isUsableName(names, patterns []string, name string) error {
 	return nil
 }
 
+// IsUsableUsername returns an error when a username is reserved
 func IsUsableUsername(name string) error {
 	return isUsableName(reservedUsernames, reservedUserPatterns, name)
 }
@@ -665,7 +666,7 @@ func parseUserFromCode(code string) (user *User) {
 	return nil
 }
 
-// verify active code when active account
+// VerifyUserActiveCode verify active code when active account
 func VerifyUserActiveCode(code string) (user *User) {
 	minutes := setting.Service.ActiveCodeLives
 
@@ -681,7 +682,7 @@ func VerifyUserActiveCode(code string) (user *User) {
 	return nil
 }
 
-// verify active code when active account
+// VerifyActiveEmailCode verify active code when active account
 func VerifyActiveEmailCode(code, email string) *EmailAddress {
 	minutes := setting.Service.ActiveCodeLives
 
@@ -910,6 +911,7 @@ func UserPath(userName string) string {
 	return filepath.Join(setting.RepoRootPath, strings.ToLower(userName))
 }
 
+// GetUserByKeyID get user information by user's public key id
 func GetUserByKeyID(keyID int64) (*User, error) {
 	user := new(User)
 	has, err := x.SQL("SELECT a.* FROM `user` AS a, public_key AS b WHERE a.id = b.owner_id AND b.id=?", keyID).Get(user)
@@ -1113,6 +1115,7 @@ type Follow struct {
 	FollowID int64 `xorm:"UNIQUE(follow)"`
 }
 
+// IsFollowing returns true if user is following followID.
 func IsFollowing(userID, followID int64) bool {
 	has, _ := x.Get(&Follow{UserID: userID, FollowID: followID})
 	return has

models/webhook.go

@@ -762,6 +762,7 @@ func DeliverHooks() {
 	}
 }
 
+// InitDeliverHooks starts the hooks delivery thread
 func InitDeliverHooks() {
 	go DeliverHooks()
 }

models/webhook_discord.go

@@ -57,14 +57,17 @@ func (p *DiscordPayload) JSONPayload() ([]byte, error) {
 	return data, nil
 }
 
+// DiscordTextFormatter formats text
 func DiscordTextFormatter(s string) string {
 	return strings.Split(s, "\n")[0]
 }
 
+// DiscordLinkFormatter formats link
 func DiscordLinkFormatter(url string, text string) string {
 	return fmt.Sprintf("[%s](%s)", text, url)
 }
 
+// DiscordSHALinkFormatter formats SHA text
 func DiscordSHALinkFormatter(url string, text string) string {
 	return fmt.Sprintf("[`%s`](%s)", text, url)
 }
@@ -370,6 +373,7 @@ func getDiscordReleasePayload(p *api.ReleasePayload) (*DiscordPayload, error) {
 	}, nil
 }
 
+// GetDiscordPayload converts a discord webhook into a DiscordPayload
 func GetDiscordPayload(p api.Payloader, event HookEventType, meta string) (payload *DiscordPayload, err error) {
 	slack := &SlackMeta{}
 	if err := jsoniter.Unmarshal([]byte(meta), &slack); err != nil {

models/webhook_slack.go

@@ -48,7 +48,7 @@ func (p *SlackPayload) JSONPayload() ([]byte, error) {
 	return data, nil
 }
 
-// see: https://api.slack.com/docs/formatting
+// SlackTextFormatter formats text see: https://api.slack.com/docs/formatting
 func SlackTextFormatter(s string) string {
 	// replace & < >
 	s = strings.Replace(s, "&", "&amp;", -1)
@@ -57,6 +57,7 @@ func SlackTextFormatter(s string) string {
 	return s
 }
 
+// SlackShortTextFormatter formats short text
 func SlackShortTextFormatter(s string) string {
 	s = strings.Split(s, "\n")[0]
 	// replace & < >
@@ -66,6 +67,7 @@ func SlackShortTextFormatter(s string) string {
 	return s
 }
 
+// SlackLinkFormatter formats link
 func SlackLinkFormatter(url string, text string) string {
 	return fmt.Sprintf("<%s|%s>", url, SlackTextFormatter(text))
 }
@@ -287,6 +289,7 @@ func getSlackReleasePayload(p *api.ReleasePayload) (*SlackPayload, error) {
 	}, nil
 }
 
+// GetSlackPayload converts a slack webhook into a SlackPayload
 func GetSlackPayload(p api.Payloader, event HookEventType, meta string) (payload *SlackPayload, err error) {
 	slack := &SlackMeta{}
 	if err := jsoniter.Unmarshal([]byte(meta), &slack); err != nil {