Update Usage-Via-Library.md

Add details-tag to hide the kotlin code. Additionally, added a missing "java" tag for code
ArDoCo · Sep 25, 2024 · 2006444 · 2006444
1 parent da985d0
commit 2006444
Showing 1 changed file with 26 additions and 1 deletion.
diff --git a/docs/Usage-Via-Library.md b/docs/Usage-Via-Library.md
@@ -36,6 +36,9 @@ Once the library is included, you can import and use the **ClassificationMetrics
 
 ### Example for Classification Metrics:
 
+<details>
+<summary>Kotlin example</summary>
+
 ```kotlin
 import edu.kit.kastel.mcse.ardoco.metrics.ClassificationMetricsCalculator
 import edu.kit.kastel.mcse.ardoco.metrics.result.SingleClassificationResult
@@ -56,6 +59,10 @@ fun main() {
 }
 ```
 
+</details>
+<details open>
+<summary>Java example</summary>
+
 ```java
 import edu.kit.kastel.mcse.ardoco.metrics.ClassificationMetricsCalculator;
 import edu.kit.kastel.mcse.ardoco.metrics.result.SingleClassificationResult;
@@ -80,9 +87,13 @@ public class ClassificationExample {
     }
 }
 ```
+</details>
 
 ### Example for Rank Metrics:
 
+<details>
+<summary>Kotlin example</summary>
+
 ```kotlin
 import edu.kit.kastel.mcse.ardoco.metrics.RankMetricsCalculator
 import edu.kit.kastel.mcse.ardoco.metrics.result.SingleRankMetricsResult
@@ -106,6 +117,10 @@ fun main() {
 }
 ```
 
+</details>
+<details open>
+<summary>Java example</summary>
+
 ```java
 import edu.kit.kastel.mcse.ardoco.metrics.RankMetricsCalculator;
 import edu.kit.kastel.mcse.ardoco.metrics.result.SingleRankMetricsResult;
@@ -134,6 +149,7 @@ public class RankMetricsExample {
     }
 }
 ```
+</details>
 
 ## 3. Customizing the Calculations
 
@@ -147,6 +163,9 @@ The **`RelevanceBasedInput`** class allows you to pass additional relevance scor
 
 #### Code Example:
 
+<details>
+<summary>Kotlin example</summary>
+
 ```kotlin
 import edu.kit.kastel.mcse.ardoco.metrics.RankMetricsCalculator
 import edu.kit.kastel.mcse.ardoco.metrics.result.SingleRankMetricsResult
@@ -188,7 +207,11 @@ fun main() {
 }
 ```
 
-```
+</details>
+<details open>
+<summary>Java example</summary>
+
+```java
 import edu.kit.kastel.mcse.ardoco.metrics.RankMetricsCalculator;
 import edu.kit.kastel.mcse.ardoco.metrics.result.SingleRankMetricsResult;
 import edu.kit.kastel.mcse.ardoco.metrics.internal.RelevanceBasedInput;
@@ -233,6 +256,8 @@ public class RankMetricsWithRelevanceExample {
     }
 }
 ```
+</details>
+
 
 #### Explanation:
 1. **Ranked Results**: A list of lists where each list represents ranked items for a query.