summaryrefslogtreecommitdiff
path: root/Rx/v2/src/rxcpp/sources/rx-never.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'Rx/v2/src/rxcpp/sources/rx-never.hpp')
-rw-r--r--Rx/v2/src/rxcpp/sources/rx-never.hpp15
1 files changed, 15 insertions, 0 deletions
diff --git a/Rx/v2/src/rxcpp/sources/rx-never.hpp b/Rx/v2/src/rxcpp/sources/rx-never.hpp
index bcb991e..cd6f4d0 100644
--- a/Rx/v2/src/rxcpp/sources/rx-never.hpp
+++ b/Rx/v2/src/rxcpp/sources/rx-never.hpp
@@ -7,6 +7,19 @@
#include "../rx-includes.hpp"
+/*! \file rx-naver.hpp
+
+ \brief Returns an observable that never sends any items or notifications to observer.
+
+ \tparam T the type of (not) emitted items
+
+ \return Observable that never sends any items or notifications to observer.
+
+ \sample
+ \snippet never.cpp never sample
+ \snippet output.txt never sample
+*/
+
namespace rxcpp {
namespace sources {
@@ -23,6 +36,8 @@ struct never : public source_base<T>
}
+/*! @copydoc rx-never.hpp
+ */
template<class T>
auto never()
-> observable<T, detail::never<T>> {