Class Samples

java.lang.Object

ai.redouble.docs.Samples

public class Samples
extends Object

Checks that the code a page shows is the code that compiles. A fenced block preceded by the directive <!-- sample: path/To.java#region --> is a checked sample: its body must equal, line for line, the lines between // region <name> and // endregion in that source file, the path relative to the markdown file. The comparison ignores the region's common indentation and trailing whitespace; marker lines of other regions nested inside are not part of the sample. The page carries the code inline, so it reads whole in the tree, and the build proves it current: a missing file, a missing region, a directive with no fence under it, or a fence that differs fails the site with the region's text as it stands, ready to paste.

Since:

0.1 (2026-09-27)

Author:

Andrey Santrosyan

Constructor Summary

Constructors

Constructor	Description
Samples()

Method Summary

Modifier and Type	Method	Description
static List<String>	check(String markdown, Path page)	The problems of every checked sample in one page; empty when all match.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Samples

public Samples()

Method Details

check

public static List<String> check(String markdown,
 Path page)
                          throws IOException

The problems of every checked sample in one page; empty when all match.

Throws:

IOException