Introduce automatic version stamping in the documentation

[senf.git] / Socket / SocketPolicy.ct

diff --git a/Socket/SocketPolicy.ct b/Socket/SocketPolicy.ct
index cbcfd30..3f07f25 100644 (file)
--- a/Socket/SocketPolicy.ct
+++ b/Socket/SocketPolicy.ct
@@ -36,6 +36,9 @@ template < BOOST_PP_SEQ_FOR_EACH_I( SP_TemplateArgs, , SENF_SOCKET_POLICIES ) >
 prefix_ void senf::SocketPolicy< BOOST_PP_SEQ_FOR_EACH_I( SP_TemplateParams, , SENF_SOCKET_POLICIES ) >::
 checkBaseOf(SocketPolicyBase const & other)
 {
+    // check, wether each policy of other is (dynamically!) convertible
+    // to the corresponding (static) policy of this class. Throws
+    // std::bad_cast on failure
 #   define SP_CheckPolicy(x1,x2,SomePolicy) (void) dynamic_cast<SomePolicy const &>(other.BOOST_PP_CAT(the,SomePolicy)());
     BOOST_PP_SEQ_FOR_EACH( SP_CheckPolicy, , SENF_SOCKET_POLICIES )
 #   undef SP_CheckPolicy