Added more source documentation.

This commit is contained in:
Jens Luedicke
2011-01-23 13:13:55 +01:00
parent d28ec4eeeb
commit 7b8555c30e
2 changed files with 23 additions and 2 deletions

View File

@@ -38,7 +38,11 @@ public:
//! //!
//! \class attribute //! \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<typename T> template<typename T>
class attribute : public abstract_attribute { class attribute : public abstract_attribute {

View File

@@ -20,10 +20,27 @@
#include <boost/concept_check.hpp> #include <boost/concept_check.hpp>
#include <boost/lexical_cast.hpp> #include <boost/lexical_cast.hpp>
//!
//! \namespace string2type
//! \brief String conversion functions.
//!
//! Default namespace for string to type conversion functions.
//!
namespace string2type { 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<T>. 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<typename T> template<typename T>
T convert(const std::string &value) { T convert(const std::string &value) {