From 21d8cf46f00be7134f241c319111a201d67617a9 Mon Sep 17 00:00:00 2001 From: Dan Goodliffe Date: Mon, 5 Jun 2017 12:48:49 +0100 Subject: Add doxygen comments --- libdbpp/types.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/libdbpp/types.h b/libdbpp/types.h index 3db6807..79a828d 100644 --- a/libdbpp/types.h +++ b/libdbpp/types.h @@ -6,15 +6,19 @@ #include namespace DB { + /// Wrapper class for reference an existing block of binary data. class DLL_PUBLIC Blob { public: + /// Construct a reference using C-style pointer and length. Blob(const void * data, size_t len); + /// Construct a reference using C++ template pointer to an object. template Blob(const T * t) : data(t), len(sizeof(T)) { } + /// Construct a reference using C++ vector pointer to a collection of objects. template Blob(const std::vector & v) : data(&v.front()), @@ -22,7 +26,9 @@ namespace DB { { } + /// The beginning of the binary data. const void * data; + /// The length of the binary data. size_t len; }; } -- cgit v1.2.3