From 7b8555c30e4517d02e201aa30d11f9f96688f974 Mon Sep 17 00:00:00 2001 From: Jens Luedicke Date: Sun, 23 Jan 2011 13:13:55 +0100 Subject: [PATCH] Added more source documentation. --- src/attributes.hpp | 6 +++++- src/string2type.hpp | 19 ++++++++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/src/attributes.hpp b/src/attributes.hpp index 2991a95..a544e37 100644 --- a/src/attributes.hpp +++ b/src/attributes.hpp @@ -38,7 +38,11 @@ public: //! //! \class attribute -//! \brief wrapper class for class attributes. +//! \brief attribute class. +//! +//! Wraps a reference to an object of type T. +//! +//! \tparam T Assignable type //! template class attribute : public abstract_attribute { diff --git a/src/string2type.hpp b/src/string2type.hpp index 3d04c3f..12ba2c5 100644 --- a/src/string2type.hpp +++ b/src/string2type.hpp @@ -20,10 +20,27 @@ #include #include +//! +//! \namespace string2type +//! \brief String conversion functions. +//! +//! Default namespace for string to type conversion functions. +//! namespace string2type { //! -//! string-to-type conversion function. +//! \brief string-to-type conversion function. +//! +//! Converts input string \e value into type T of template argument. Internally +//! the function calls boost::lexical_cast. If you need a specialiized convert function +//! for your given type, you need to implement a specialized convert function. +//! +//! \tparam T return type of function. +//! +//! \param value Input string for function. +//! +//! \returns Converted value. +//! //! template T convert(const std::string &value) {