Package ch.so.agi.hop.doclint.validate

Class DocumentationValidator

java.lang.Object
ch.so.agi.hop.doclint.validate.DocumentationValidator
public final class DocumentationValidator extends Object
Validates the AsciiDoc page of every discovered plugin element.

The page is derived from documentationUrl by convention. Two URL forms are supported:

  • a page URL: the file name maps to the AsciiDoc file (.../transforms/example.html to docs/transforms/example.adoc),
  • a single-page handbook URL with fragment: the fragment maps to the AsciiDoc file and must be declared as an explicit anchor (.../index.html#example to docs/transforms/example.adoc with [[example]]).

No mapping file exists. The annotation id, the :plugin-id: attribute and the file name must match.