ScriptEngineFactory.createScriptEngine() - describe purpose of parameter

Author: dilyanpalauzov

bundles/org.openhab.core.automation.module.script/src/main/java/org/openhab/core/automation/module/script/ScriptEngineFactory.java

@@ -68,9 +68,12 @@ public interface ScriptEngineFactory {
 
     /**
      * This method creates a new ScriptEngine based on the supplied file extension or MimeType.
+     * openHAB-core always passes as parameter one of the values, returned by getScriptTypes().
+     * The parameter serves for a ScriptEngineFactory, which announces support for several
+     * languages, e.g. Pascal and PHP, to create a ScriptEngine for the requested language.
      *
      * @param scriptType a file extension (script) or MimeType (ScriptAction or ScriptCondition)
-     * @return ScriptEngine or null
+     * @return ScriptEngine or, in case of error, null
      */
     @Nullable
     ScriptEngine createScriptEngine(String scriptType);