diff options
author | Chris Sherlock <chris.sherlock79@gmail.com> | 2014-02-04 19:55:39 +0000 |
---|---|---|
committer | Caolán McNamara <caolanm@redhat.com> | 2014-02-05 09:14:53 +0000 |
commit | 51a68b4992c6eb7015d838d1fdf9fc84ec0fa5d2 (patch) | |
tree | 3fe907e6cdefffc48000197ec7f94d9f8c104858 /include/vcl/threadex.hxx | |
parent | 651756a5f40b6340518e97a31113cb59438ab40d (diff) |
Doxygen warnings corrected
* Doxygen spits out a lot of warnings about not being able to find
match function signatures, etc. This is because in some headers we
have a using namespace statement, in others it gets confused between
::Window and Window (!).
* Wrong use of tags:
+ Lots of @seealso - should be @see
+ Wrong usage of @overload - corrected with the right function
signature
+ HTML tags that doxygen doesn't recognize removed
Change-Id: I1c2eed941619b8764dbfcfc5ab38027518cdf261
Diffstat (limited to 'include/vcl/threadex.hxx')
-rw-r--r-- | include/vcl/threadex.hxx | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/vcl/threadex.hxx b/include/vcl/threadex.hxx index 51876033d5e4..9433e394df39 100644 --- a/include/vcl/threadex.hxx +++ b/include/vcl/threadex.hxx @@ -204,11 +204,11 @@ inline detail::copy_back_wrapper<T> inout_by_ptr( T * p ) (e.g. for out parameters) to foreign threads, use inout_by_ref() for this purpose. For in parameters, this may not affect you, because the functor object is copy constructed into free store. This way - you must not use boost::cref()/boost::ref() or similar for objects on - your thread's stack. + you must not use \verbatim boost::cref()/boost::ref() \endverbatim or similar + for objects on your thread's stack. Use inout_by_ref() or inout_by_ptr() for this purpose, e.g. - <pre> + \code{.cpp} using namespace vcl::solarthread; long n = 3; @@ -222,7 +222,7 @@ inline detail::copy_back_wrapper<T> inout_by_ptr( T * p ) syncExecute( boost::bind( &foo, inout_by_ptr(&pc) ) ); // calling foo( char const*& rpc ): syncExecute( boost::bind( &foo, inout_by_ref(pc) ) ); - </pre> + \endcode @tpl ResultT result type, defaults to FuncT::result_type to seamlessly support mem_fn and bind |