Document exception throwing

alllex · Jun 26, 2023 · 53bba91 · 53bba91
1 parent a3a828c
commit 53bba91
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/src/commonMain/kotlin/me/alllex/parsus/parser/Grammar.kt b/src/commonMain/kotlin/me/alllex/parsus/parser/Grammar.kt
@@ -71,6 +71,7 @@ abstract class Grammar<out V>(
      * If parsing is successful, returns a value.
      * Otherwise, throws a [ParseException] containing an error.
      */
+    @Throws(ParseException::class)
     fun parseEntireOrThrow(input: String): V {
         return parseEntire(input).getOrThrow()
     }

diff --git a/src/commonMain/kotlin/me/alllex/parsus/parser/ParseResult.kt b/src/commonMain/kotlin/me/alllex/parsus/parser/ParseResult.kt
@@ -51,6 +51,7 @@ inline fun <T> ParseResult<T>.getOrElse(f: (ParseError) -> T): T {
     }
 }
 
+@Throws(ParseException::class)
 fun <T> ParseResult<T>.getOrThrow(): T {
     return when (this) {
         is ParsedValue -> value