From 9e7482c15420008f4e643e63a1f729c20f3ac1cc Mon Sep 17 00:00:00 2001 From: Dmitry Marakasov Date: Fri, 26 Dec 2014 20:54:22 +0300 Subject: [PATCH] Document Optional --- SDL2pp/Optional.hh | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/SDL2pp/Optional.hh b/SDL2pp/Optional.hh index a87c252..abaa61d 100644 --- a/SDL2pp/Optional.hh +++ b/SDL2pp/Optional.hh @@ -24,6 +24,48 @@ #include +//////////////////////////////////////////////////////////// +/// \class SDL2pp::Optional +/// +/// \brief Optional value container +/// +/// \ingroup general +/// +/// \headerfile SDL2pp/Optional.hh +/// +/// This class contains an optional value, i.e. a value that +/// semantically may not be present. +/// +/// \see http://en.cppreference.com/w/cpp/experimental/optional +/// +//////////////////////////////////////////////////////////// + +//////////////////////////////////////////////////////////// +/// \class SDL2pp::BadOptionalAccess +/// +/// \brief %Exception thrown on accessing a SDL2pp::Optional object with uninitialized state +/// +/// \ingroup general +/// +/// \headerfile SDL2pp/Optional.hh +/// +/// \see http://en.cppreference.com/w/cpp/utility/bad_optional_access +/// +//////////////////////////////////////////////////////////// + +//////////////////////////////////////////////////////////// +/// \var SDL2pp::NullOpt +/// +/// \brief Null value for SDL2pp::Optional +/// +/// \ingroup general +/// +/// \headerfile SDL2pp/Optional.hh +/// +/// \see http://en.cppreference.com/w/cpp/experimental/optional +/// +//////////////////////////////////////////////////////////// + #if defined(SDL2PP_WITH_EXPERIMENTAL_OPTIONAL) # include