Description & Parameter Formatting

From Obsidian Scheduler
Jump to: navigation, search

As of version 4.3.0, Obsidian supports formatting of job @Description and @Parameter.description, with default Markdown formatter support.


Obsidian-4.3.0.ParameterFormatting.PNG

Formatter Interface

Formatter Javadoc.

This interface defines the formatting contract used by Obsidian in formatting all @Description and @Parameter.description values. An optional parameter, com.carfey.obsidian.formatterClass may be specified in your configuration to override the default class: MarkdownFormatter.

Implementing your own Formatter allows for alternate formatting implementations producing valid HTML.

MarkdownFormatter

MarkdownFormatter javadoc.

The default implementation using the flexmark-java library.