mirror of https://github.com/adamdruppe/arsd.git
Add further doc comments to `arsd.ini`
This commit is contained in:
parent
7d13f7cf22
commit
5d3a57ea1a
23
ini.d
23
ini.d
|
@ -34,30 +34,45 @@ private bool hasFeature(ulong dialect, ulong feature) @safe pure nothrow @nogc {
|
||||||
return ((dialect & feature) > 0);
|
return ((dialect & feature) > 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
///
|
/++
|
||||||
|
Type of a token (as output by the parser)
|
||||||
|
+/
|
||||||
public enum IniTokenType {
|
public enum IniTokenType {
|
||||||
|
/// indicates an error
|
||||||
invalid = 0,
|
invalid = 0,
|
||||||
|
|
||||||
|
/// insignificant whitespace
|
||||||
whitespace,
|
whitespace,
|
||||||
|
/// section header opening bracket
|
||||||
bracketOpen,
|
bracketOpen,
|
||||||
|
/// section header closing bracket
|
||||||
bracketClose,
|
bracketClose,
|
||||||
|
/// key/value separator, e.g. '='
|
||||||
keyValueSeparator,
|
keyValueSeparator,
|
||||||
|
/// line break, i.e. LF, CRLF or CR
|
||||||
lineBreak,
|
lineBreak,
|
||||||
|
|
||||||
|
/// text comment
|
||||||
comment,
|
comment,
|
||||||
|
|
||||||
|
/// item key data
|
||||||
key,
|
key,
|
||||||
|
/// item value data
|
||||||
value,
|
value,
|
||||||
|
/// section name data
|
||||||
sectionHeader,
|
sectionHeader,
|
||||||
}
|
}
|
||||||
|
|
||||||
///
|
/++
|
||||||
|
Token of INI data (as output by the parser)
|
||||||
|
+/
|
||||||
struct IniToken(string) if (isCompatibleString!string) {
|
struct IniToken(string) if (isCompatibleString!string) {
|
||||||
|
|
||||||
///
|
///
|
||||||
IniTokenType type;
|
IniTokenType type;
|
||||||
|
|
||||||
///
|
/++
|
||||||
|
Content
|
||||||
|
+/
|
||||||
string data;
|
string data;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue