Interface HelpLayoutRenderer<S extends Source,C>

Type Parameters:
S - the source type
C - the component type
All Known Implementing Classes:
StandardHelpRenderer

public interface HelpLayoutRenderer<S extends Source,C>
Interface for rendering help documentation. Simplified to use HelpTheme directly instead of HelpRenderOptions.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    render(@NotNull ExecutionContext<S> context, @NotNull HelpEntryList<S> helpEntries, @NotNull HelpTheme<S,C> theme)
    Renders the help documentation to the source.
  • Method Details

    • render

      void render(@NotNull @NotNull ExecutionContext<S> context, @NotNull @NotNull HelpEntryList<S> helpEntries, @NotNull @NotNull HelpTheme<S,C> theme)
      Renders the help documentation to the source.
      Parameters:
      context - The execution context, containing information about the command and source.
      helpEntries - A list of all available help entries for the current context.
      theme - The theme that controls how the help is displayed.