Skip to content

Commit 2e1b56f

Browse files
committed
docs: Add comments in CodeXPChallengeFactory
1 parent 4090028 commit 2e1b56f

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

src/main/kotlin/com/github/ilovegamecoding/intellijcodexp/models/CodeXPChallengeFactory.kt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,17 @@ package com.github.ilovegamecoding.intellijcodexp.models
22

33
import com.github.ilovegamecoding.intellijcodexp.enums.Event
44

5+
/**
6+
* CodeXPChallenge class
7+
*
8+
* CodeXPChallenge is a class that represents a challenge. Challenges are used to track the progress of the user.
9+
*/
510
object CodeXPChallengeFactory {
11+
/**
12+
* Creates a list of default challenges.
13+
*
14+
* @return List of default challenges.
15+
*/
616
fun createEventDefaultChallenges(): List<CodeXPChallenge> {
717
return listOf(
818
createChallenge(
@@ -69,6 +79,17 @@ object CodeXPChallengeFactory {
6979
)
7080
}
7181

82+
/**
83+
* Creates a challenge with the given parameters.
84+
*
85+
* @param event Event of challenge.
86+
* @param name Name of challenge.
87+
* @param description Description of challenge.
88+
* @param goal Goal of challenge.
89+
* @param rewardXP Reward XP of challenge when completed.
90+
* @param rewardXPIncrement Increment of reward XP of challenge when completed.
91+
* @return Challenge with the given parameters.
92+
*/
7293
private fun createChallenge(
7394
event: Event,
7495
name: String,

0 commit comments

Comments
 (0)