TheCloud/libSDL2pp
1
0
Fork 0
mirror of https://github.com/libSDL2pp/libSDL2pp.git synced 2025-08-04 03:15:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document Optional

Browse Source
This commit is contained in:
Dmitry Marakasov 2014-12-26 20:54:22 +03:00
parent d6d272a35d
commit 9e7482c154
1 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
SDL2pp/Optional.hh
View File

@ -24,6 +24,48 @@
#include <SDL2pp/Config.hh>
////////////////////////////////////////////////////////////
/// \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 <experimental/optional>