From 032e915e6829b40a3a01f81f33d3318a0d65811c Mon Sep 17 00:00:00 2001
From: sschr15 <steven.sschr15@hotmail.com>
Date: Sun, 18 Aug 2024 17:26:00 -0500
Subject: [PATCH] Add documentation on the option getters

---
 .../jetbrains/java/decompiler/api/DecompilerOption.java  | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/org/jetbrains/java/decompiler/api/DecompilerOption.java b/src/org/jetbrains/java/decompiler/api/DecompilerOption.java
index f1fffbc05..79e9e3155 100644
--- a/src/org/jetbrains/java/decompiler/api/DecompilerOption.java
+++ b/src/org/jetbrains/java/decompiler/api/DecompilerOption.java
@@ -69,6 +69,10 @@ public int compareTo(@NotNull DecompilerOption decompilerOption) {
     return id.compareTo(decompilerOption.id);
   }
 
+  /**
+   * Get all decompiler options from all plugins and the core decompiler.
+   * @return A list of all decompiler options, sorted by plugin and id, with core decompiler options first.
+   */
   public static List<DecompilerOption> getAll() {
     List<DecompilerOption> options = new ArrayList<>();
 
@@ -104,6 +108,11 @@ public static List<DecompilerOption> getAll() {
     return options;
   }
 
+  /**
+   * Get all decompiler options from all plugins and the core decompiler, grouped by plugin.
+   * Calling {@link Map#get} with {@code null} will return the core decompiler options.
+   * @return A map of plugins to their decompiler options, sorted by id within each plugin.
+   */
   public static Map<Plugin, List<DecompilerOption>> getAllByPlugin() {
     Map<Plugin, List<DecompilerOption>> options = new HashMap<>();