golint fixed for models/issue_comment.go

release/v1.15
Lunny Xiao 2016-11-28 21:33:09 +08:00
parent 9948f0daaa
commit 9fc609ce17
1 changed files with 17 additions and 7 deletions

View File

@ -21,6 +21,7 @@ import (
// CommentType defines whether a comment is just a simple comment, an action (like close) or a reference. // CommentType defines whether a comment is just a simple comment, an action (like close) or a reference.
type CommentType int type CommentType int
// Enumerate all the comment types
const ( const (
// Plain comment, can be associated with a commit (CommitID > 0) and a line (LineNum > 0) // Plain comment, can be associated with a commit (CommitID > 0) and a line (LineNum > 0)
CommentTypeComment CommentType = iota CommentTypeComment CommentType = iota
@ -37,8 +38,10 @@ const (
CommentTypePullRef CommentTypePullRef
) )
// CommentTag defines comment tag type
type CommentTag int type CommentTag int
// Enumerate all the comment tag types
const ( const (
CommentTagNone CommentTag = iota CommentTagNone CommentTag = iota
CommentTagPoster CommentTagPoster
@ -72,15 +75,19 @@ type Comment struct {
ShowTag CommentTag `xorm:"-"` ShowTag CommentTag `xorm:"-"`
} }
// BeforeInsert will be invoked by XORM before inserting a record
// representing this object.
func (c *Comment) BeforeInsert() { func (c *Comment) BeforeInsert() {
c.CreatedUnix = time.Now().Unix() c.CreatedUnix = time.Now().Unix()
c.UpdatedUnix = c.CreatedUnix c.UpdatedUnix = c.CreatedUnix
} }
// BeforeUpdate is invoked from XORM before updating this object.
func (c *Comment) BeforeUpdate() { func (c *Comment) BeforeUpdate() {
c.UpdatedUnix = time.Now().Unix() c.UpdatedUnix = time.Now().Unix()
} }
// AfterSet is invoked from XORM after setting the value of a field of this object.
func (c *Comment) AfterSet(colName string, _ xorm.Cell) { func (c *Comment) AfterSet(colName string, _ xorm.Cell) {
var err error var err error
switch colName { switch colName {
@ -107,6 +114,7 @@ func (c *Comment) AfterSet(colName string, _ xorm.Cell) {
} }
} }
// AfterDelete is invoked from XORM after the object is deleted.
func (c *Comment) AfterDelete() { func (c *Comment) AfterDelete() {
_, err := DeleteAttachmentsByComment(c.ID, true) _, err := DeleteAttachmentsByComment(c.ID, true)
@ -115,6 +123,7 @@ func (c *Comment) AfterDelete() {
} }
} }
// APIFormat converts a Comment to the api.Comment format
func (c *Comment) APIFormat() *api.Comment { func (c *Comment) APIFormat() *api.Comment {
return &api.Comment{ return &api.Comment{
ID: c.ID, ID: c.ID,
@ -137,21 +146,21 @@ func (c *Comment) EventTag() string {
// MailParticipants sends new comment emails to repository watchers // MailParticipants sends new comment emails to repository watchers
// and mentioned people. // and mentioned people.
func (cmt *Comment) MailParticipants(opType ActionType, issue *Issue) (err error) { func (c *Comment) MailParticipants(opType ActionType, issue *Issue) (err error) {
mentions := markdown.FindAllMentions(cmt.Content) mentions := markdown.FindAllMentions(c.Content)
if err = UpdateIssueMentions(cmt.IssueID, mentions); err != nil { if err = UpdateIssueMentions(c.IssueID, mentions); err != nil {
return fmt.Errorf("UpdateIssueMentions [%d]: %v", cmt.IssueID, err) return fmt.Errorf("UpdateIssueMentions [%d]: %v", c.IssueID, err)
} }
switch opType { switch opType {
case ActionCommentIssue: case ActionCommentIssue:
issue.Content = cmt.Content issue.Content = c.Content
case ActionCloseIssue: case ActionCloseIssue:
issue.Content = fmt.Sprintf("Closed #%d", issue.Index) issue.Content = fmt.Sprintf("Closed #%d", issue.Index)
case ActionReopenIssue: case ActionReopenIssue:
issue.Content = fmt.Sprintf("Reopened #%d", issue.Index) issue.Content = fmt.Sprintf("Reopened #%d", issue.Index)
} }
if err = mailIssueCommentToParticipants(issue, cmt.Poster, mentions); err != nil { if err = mailIssueCommentToParticipants(issue, c.Poster, mentions); err != nil {
log.Error(4, "mailIssueCommentToParticipants: %v", err) log.Error(4, "mailIssueCommentToParticipants: %v", err)
} }
@ -272,6 +281,7 @@ func createStatusComment(e *xorm.Session, doer *User, repo *Repository, issue *I
}) })
} }
// CreateCommentOptions defines options for creating comment
type CreateCommentOptions struct { type CreateCommentOptions struct {
Type CommentType Type CommentType
Doer *User Doer *User
@ -374,7 +384,7 @@ func GetCommentsByIssueID(issueID int64) ([]*Comment, error) {
return getCommentsByIssueID(x, issueID) return getCommentsByIssueID(x, issueID)
} }
// GetCommentsByIssueID returns a list of comments of an issue since a given time point. // GetCommentsByIssueIDSince returns a list of comments of an issue since a given time point.
func GetCommentsByIssueIDSince(issueID, since int64) ([]*Comment, error) { func GetCommentsByIssueIDSince(issueID, since int64) ([]*Comment, error) {
return getCommentsByIssueIDSince(x, issueID, since) return getCommentsByIssueIDSince(x, issueID, since)
} }