From 362e0d360035df0c12de4297204d55aaa1f9a064 Mon Sep 17 00:00:00 2001
From: Dan Goodliffe <dan@randomdan.homeip.net>
Date: Mon, 3 Sep 2018 20:57:12 +0100
Subject: Add missing doxygen comments

---
 libadhocutil/compileTimeFormatter.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/libadhocutil/compileTimeFormatter.h b/libadhocutil/compileTimeFormatter.h
index 77fa753..2fc193e 100644
--- a/libadhocutil/compileTimeFormatter.h
+++ b/libadhocutil/compileTimeFormatter.h
@@ -49,8 +49,10 @@ namespace AdHoc {
 
 	template <const auto & S, decltype(strlen<S>())> class Formatter;
 
+	/// Template used to apply parameters to a stream.
 	template<const auto & S, auto L, auto pos, typename stream, typename, auto ...>
 	struct StreamWriter {
+		/// Write parameters to stream.
 		template<typename ... Pn>
 		static void write(stream &, const Pn & ...)
 		{
@@ -58,8 +60,10 @@ namespace AdHoc {
 		}
 	};
 
+	/// Helper to simplify implementations of StreamWriter.
 	template<const auto & S, auto L, auto pos, typename stream>
 	struct StreamWriterBase {
+		/// Continue processing parameters.
 		template<typename ... Pn>
 		static inline void next(stream & s, const Pn & ... pn)
 		{
@@ -120,6 +124,7 @@ namespace AdHoc {
 			template<const auto &, auto, auto, typename> friend struct StreamWriterBase;
 
 		public:
+			/// The derived charater type of the format string.
 			typedef typename std::decay<decltype(*S)>::type char_type;
 			/**
 			 * Get a string containing the result of formatting.
-- 
cgit v1.2.3