All Interfaces

NameShort DescriptionParent
build system
currently restricted to Gradle: The build system uses HtmlSC as configured in the buildscript.
Command Line Interface → Checker
Exposes the #AllChecksRunner class, as described in AllChecksRunner.
Gradle Plugin → Checker
Exposes HtmlSC via a standard Gradle plugin, as described in the Gradle user guide.
Interface CheckResults
The Gradle CheckResults Java-API.
Results
Interface PageResults
The Gradle PageResults Java-API.
Results
Interface RunResults
The Gradle RunResults Java-API.
Results
local-html and local-images
HtmlSC needs access to several local files, especially the html page to be checked and to the corresponding image directories.
Results
The Result interface is used by all clients (especially Reporter subclasses, graphical and command-line clients) to access checking results. It consists of three distinct APIs for overall RunResults, single-page results (PageResults) and single-check results (CheckResults).
usage via shell
arc42 user uses a command line shell to call the HtmlSC

Interfaces

Need more info?

Click the link below, if you need more information on documenting.

Related Information

The following links direct you to related documentation within your wiki.