Skip to content

Commit 31c0ecb

Browse files
mnonnenmachernnobelis
authored andcommitted
docs(model): Add docs for the Issue properties
Signed-off-by: Martin Nonnenmacher <[email protected]>
1 parent 542bcff commit 31c0ecb

File tree

1 file changed

+10
-0
lines changed
  • model/src/commonMain/kotlin/runs

1 file changed

+10
-0
lines changed

model/src/commonMain/kotlin/runs/Issue.kt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,20 @@ import kotlinx.serialization.Serializable
2424

2525
import org.eclipse.apoapsis.ortserver.model.Severity
2626

27+
/**
28+
* A data class describing an issue that occurred during an ORT run.
29+
*/
2730
@Serializable
2831
data class Issue(
32+
/** The timestamp when this issue occurred. */
2933
val timestamp: Instant,
34+
35+
/** The source where this issue occurred. */
3036
val source: String,
37+
38+
/** A message describing the issue. */
3139
val message: String,
40+
41+
/** The [Severity] of the issue. */
3242
val severity: Severity
3343
)

0 commit comments

Comments
 (0)