X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FSocketPolicy.hh;h=6fd63c9a831f414301558e73f16b3de0ec26b78c;hb=33157146abaca548e145c577a0840cd1bd427789;hp=c0723b0a49b6a2c69cc65d2a52b08399346d137f;hpb=5a5c6d7f0fae7ad6c0af49d7742955cb6cf618cf;p=senf.git diff --git a/Socket/SocketPolicy.hh b/Socket/SocketPolicy.hh index c0723b0..6fd63c9 100644 --- a/Socket/SocketPolicy.hh +++ b/Socket/SocketPolicy.hh @@ -228,6 +228,14 @@ with \c SocketPolicyIsBaseOf. */ +/** \defgroup policy_impl_group Policy Implementation classes + \ingroup policy_group + + Here you will find all policy classes. Also included are some + supporting classes which are used as base classes to build other + policy classes. + */ + #ifndef HH_SocketPolicy_ #define HH_SocketPolicy_ 1 @@ -431,7 +439,7 @@ namespace senf { /** \brief Check single policy axis - This template is an example of the \i Policy \c Is family of + This template is an example of the \e Policy \c Is family of tempalte metafunctions. It will check, wether \c Trait is a valid compatible Policy class of \c SocketPolicy. \c Trait must be derived from AddressingPolicyBase (respectively \i @@ -445,11 +453,11 @@ namespace senf { /** \brief Enable template overload depending on policy value - This template is an exmaple of the \c If \i Policy \c Is + This template is an exmaple of the \c If \e Policy \c Is family of templates. It is used like Boost.enable_if to enable a templated overload only, if the AddressingPolicy - of \i Policy is compatible with \c Trait (that is the + of \e Policy is compatible with \c Trait (that is the AddressingPolicy of \c Policy is derived from \c Trait). \see policy_group @@ -500,7 +508,7 @@ namespace senf { A SocketPolicy can be complete or incomplete. An incomplete SocketPolicy will have at least one axis set to \c Undefined - \i Policy (or a generic derived class which is used to group + \e Policy (or a generic derived class which is used to group some other policies but does not (completely) define the policy behavior). A complete SocketPolicy will have a concrete definition of the desired behavior for each policy @@ -533,7 +541,7 @@ namespace senf { SocketPolicy instantiation. It takes any number (that is up to 6) of Policy classes as arguments in any Order. It will create a SocketPolicy from these policy classes. Any axis not - specified will be left as \c Unspecified \i Policy. + specified will be left as \c Unspecified \e Policy. \see policy_group */