Guides

DirectiveValueType
in package

The kind of value a directive accepts right after `::`, declared via {@see \phpDocumentor\Guides\RestructuredText\Directives\Attributes\Directive::$valueType}.

Options have their own OptionType: what a directive's value may be and what an option's value may be can differ, so the two are kept apart.

Table of Contents

Cases

Array
A comma-separated list of scalar values.
Boolean
Empty
No value is expected; one supplied anyway is likely a mistake.
Inline
Parsed as inline markup (bold, links, roles, ...), like body text.
Integer
Path
A file or asset path, resolved relative to the current document.
String
A raw string, used as-is -- never parsed as inline markup.
Url
An external URL.

Cases

On this page

Search results