Documentation

SpecReader
in package

FinalYes

Reads in a CommonMark spec document and extracts the input/output examples for testing against them

Table of Contents

Methods

read()  : iterable<string, array{input: string, output: string, type: string, section: string, number: int}>
readFile()  : iterable<string, array{input: string, output: string, type: string, section: string, number: int}>
__construct()  : mixed

Methods

read()

public static read(string $data) : iterable<string, array{input: string, output: string, type: string, section: string, number: int}>
Parameters
$data : string
Return values
iterable<string, array{input: string, output: string, type: string, section: string, number: int}>

readFile()

public static readFile(string $filename) : iterable<string, array{input: string, output: string, type: string, section: string, number: int}>
Parameters
$filename : string
Tags
throws
IOException

if the file cannot be loaded

Return values
iterable<string, array{input: string, output: string, type: string, section: string, number: int}>

        
On this page

Search results