summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Goodliffe <dan@randomdan.homeip.net>2018-09-03 20:57:12 +0100
committerDan Goodliffe <dan@randomdan.homeip.net>2018-09-03 20:57:12 +0100
commit362e0d360035df0c12de4297204d55aaa1f9a064 (patch)
tree2a1e8e1b3f6df67e92ae2fb3dd0a84f187b62ac8
parentGreatly improved CTF printf support (diff)
downloadlibadhocutil-362e0d360035df0c12de4297204d55aaa1f9a064.tar.bz2
libadhocutil-362e0d360035df0c12de4297204d55aaa1f9a064.tar.xz
libadhocutil-362e0d360035df0c12de4297204d55aaa1f9a064.zip
Add missing doxygen comments
-rw-r--r--libadhocutil/compileTimeFormatter.h5
1 files changed, 5 insertions, 0 deletions
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.