Add HTML help for module descriptions

caprica · Feb 3, 2024 · 08a9468 · 08a9468
1 parent 4abb761
commit 08a9468
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/src/main/java/uk/co/caprica/vlcj/factory/ApplicationApi.java b/src/main/java/uk/co/caprica/vlcj/factory/ApplicationApi.java
@@ -182,7 +182,7 @@ private List<ModuleDescription> getModuleDescriptions(libvlc_module_description_
         List<ModuleDescription> result = new ArrayList<ModuleDescription>();
         libvlc_module_description_t moduleDescription = moduleDescriptions;
         while(moduleDescription != null) {
-            result.add(new ModuleDescription(moduleDescription.psz_name, moduleDescription.psz_shortname, moduleDescription.psz_longname, moduleDescription.psz_help));
+            result.add(new ModuleDescription(moduleDescription.psz_name, moduleDescription.psz_shortname, moduleDescription.psz_longname, moduleDescription.psz_help, moduleDescription.psz_help_html));
             moduleDescription = moduleDescription.p_next;
         }
         return result;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/ModuleDescription.java b/src/main/java/uk/co/caprica/vlcj/factory/ModuleDescription.java
@@ -44,19 +44,26 @@ public final class ModuleDescription {
      */
     private final String help;
 
+    /**
+     * HTML help text.
+     */
+    private final String helpHtml;
+
     /**
      * Create a new module description
      *
      * @param name name
      * @param shortName short name
      * @param longName long name
      * @param help help text
+     * @param helpHtml HTML help text
      */
-    public ModuleDescription(String name, String shortName, String longName, String help) {
+    public ModuleDescription(String name, String shortName, String longName, String help, String helpHtml) {
         this.name = name;
         this.shortName = shortName;
         this.longName = longName;
         this.help = help;
+        this.helpHtml = helpHtml;
     }
 
     /**
@@ -95,14 +102,24 @@ public String help() {
         return help;
     }
 
+    /**
+     * Get the module HTML help text.
+     *
+     * @return HTML help text
+     */
+    public String helpHtml() {
+        return helpHtml;
+    }
+
     @Override
     public String toString() {
         StringBuilder sb = new StringBuilder(200);
         sb.append(getClass().getSimpleName()).append('[');
         sb.append("name=").append(name).append(',');
         sb.append("shortName=").append(shortName).append(',');
         sb.append("longName=").append(longName).append(',');
-        sb.append("help=").append(help).append(']');
+        sb.append("help=").append(help).append(',');
+        sb.append("helpHtml=").append(help).append(']');
         return sb.toString();
     }
 }