Get the "short summary" for a builtin symbol

axkr · Aug 19, 2023 · 1857147 · 1857147
1 parent a4eff16
commit 1857147
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/..._library/matheclipse-core/src/main/java/org/matheclipse/core/expression/BuiltinUsage.java b/..._library/matheclipse-core/src/main/java/org/matheclipse/core/expression/BuiltinUsage.java
@@ -2,6 +2,7 @@
 
 import java.util.concurrent.atomic.AtomicBoolean;
 import org.matheclipse.core.interfaces.IBuiltInSymbol;
+import org.matheclipse.core.interfaces.ISymbol;
 
 public class BuiltinUsage {
   private static final String[] USAGE = new String[ID.Zeta + 10];
@@ -534,6 +535,17 @@ public static synchronized void init() {
     USAGE[ID.YuleDissimilarity] = "Yule dissimilarity";
   }
 
+  public static String summaryText(String symbolStr) {
+    if (!IS_INITIALIZED.get()) {
+      init();
+    }
+    ISymbol symbol = F.symbol(symbolStr);
+    if (symbol.isBuiltInSymbol()) {
+      String str = USAGE[symbol.ordinal()];
+      return str != null ? str : "";
+    }
+    return "";
+  }
 
   /**
    * Return a short summary of the built-in symbols functionality.