core: Improve the documentation in core.rt.format on Sink and SinkArg.

VoltLang · May 27, 2018 · 22669ec · 22669ec
1 parent bc67795
commit 22669ec
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/rt/src/core/rt/format.volt b/rt/src/core/rt/format.volt
@@ -3,10 +3,18 @@
 module core.rt.format;
 
 
-/// The one true sink definition.
+/*!
+ * The argument that is passed to Sinks.
+ */
 alias SinkArg = scope const(char)[];
 
-/// The argument to the one true sink.
+/*!
+ * The Sink delegate.
+ *
+ * A Sink is a delegate that takes a `SinkArg`,
+ * and builds a string, usually with an aim
+ * to minimise needless allocations and GC calls.
+ */
 alias Sink = scope dg (SinkArg);
 
 /*!