Skip to content

Commit

Permalink
Added javadoc in added method
Browse files Browse the repository at this point in the history
  • Loading branch information
Vila committed Jul 8, 2024
1 parent 906d1a7 commit 701bf5e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/org/ods/orchestration/util/Project.groovy
Original file line number Diff line number Diff line change
Expand Up @@ -1331,6 +1331,19 @@ class Project {
return mergedData
}

/**
* The method checks each issue in the 'relatedIssues' list against the related issues in the 'deltaDocgenData'.
* If the issueToUpdate key does not appear in the deltaDocgenData as a related issue but the deltaDocGen has some
* issues related for that issue type, the issue is added to the list of issues to be removed.
*
* @param relatedIssues A list of related issues to be examined.
* @param deltaDocgenData A map containing data from the deltaDocGen
* @param relatedIssueType The type of the related issue.
* @param issueType The type of the issue.
* @param issueToUpdate A map containing the issue to be updated.
*
* @return A list of related issues that need to be removed.
*/
protected static List findRelatedIssuesToRemove(List<String> relatedIssues, Map deltaDocgenData, String relatedIssueType, String issueType, Map issueToUpdate) {
def relatedIssuesToRemove = []
relatedIssues.each {
Expand Down

0 comments on commit 701bf5e

Please sign in to comment.