chore: add documentation

This commit is contained in:
Tim-Niclas Oelschläger 2024-02-21 21:07:18 +01:00 committed by Lunny Xiao
parent c68b79f90d
commit c0d5bc43b8

View File

@ -594,11 +594,14 @@ func IsUserParticipantsOfIssue(ctx context.Context, user *user_model.User, issue
} }
// DependencyInfo represents high level information about an issue which is a dependency of another issue. // DependencyInfo represents high level information about an issue which is a dependency of another issue.
// this type is used in func `BlockingDependenciesMap` and `BlockedByDependenciesMap` as xorm intermediet type to retrive info from joined tables
type DependencyInfo struct { type DependencyInfo struct {
Issue `xorm:"extends"` Issue `xorm:"extends"` // an issue/pull that depend on issue_id or is blocked by issue_id. the exact usage is determined by the function using this type
repo_model.Repository `xorm:"extends"` repo_model.Repository `xorm:"extends"` // the repo, that owns Issue
IssueID int64 `xorm:"NOT NULL"`
DependencyID int64 `xorm:"NOT NULL"` // fields from `IssueDependency`
IssueID int64 `xorm:"NOT NULL"` // id of the issue/pull the that is used for the selection of dependent issues
DependencyID int64 `xorm:"NOT NULL"` // id of the issue/pull the that is used for the selection of blocked issues
} }
// GetParticipantIDsByIssue returns all userIDs who are participated in comments of an issue and issue author // GetParticipantIDsByIssue returns all userIDs who are participated in comments of an issue and issue author