From 5d3a57ea1a932d507fd8e5d823c960a1cb468479 Mon Sep 17 00:00:00 2001
From: Elias Batek <desisma@heidel.beer>
Date: Fri, 7 Feb 2025 05:57:35 +0100
Subject: [PATCH] Add further doc comments to `arsd.ini`

---
 ini.d | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/ini.d b/ini.d
index cdbe9e1..4e2ec6a 100644
--- a/ini.d
+++ b/ini.d
@@ -34,30 +34,45 @@ private bool hasFeature(ulong dialect, ulong feature) @safe pure nothrow @nogc {
 	return ((dialect & feature) > 0);
 }
 
-///
+/++
+	Type of a token (as output by the parser)
+ +/
 public enum IniTokenType {
+	/// indicates an error
 	invalid = 0,
 
+	/// insignificant whitespace
 	whitespace,
+	/// section header opening bracket
 	bracketOpen,
+	/// section header closing bracket
 	bracketClose,
+	/// key/value separator, e.g. '='
 	keyValueSeparator,
+	/// line break, i.e. LF, CRLF or CR
 	lineBreak,
 
+	/// text comment
 	comment,
 
+	/// item key data
 	key,
+	/// item value data
 	value,
+	/// section name data
 	sectionHeader,
 }
 
-///
+/++
+	Token of INI data (as output by the parser)
+ +/
 struct IniToken(string) if (isCompatibleString!string) {
-
 	///
 	IniTokenType type;
 
-	///
+	/++
+		Content
+	 +/
 	string data;
 }