[libsigcplusplus] Correct some doxygen comments for variadic parameters.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libsigcplusplus] Correct some doxygen comments for variadic parameters.
- Date: Wed, 20 Apr 2016 07:20:40 +0000 (UTC)
commit 2e2f9156668472a072fbabe8a5c607b0ec488a3f
Author: Murray Cumming <murrayc murrayc com>
Date: Wed Apr 20 09:17:44 2016 +0200
Correct some doxygen comments for variadic parameters.
These showed up as errors in doxygen.log.
sigc++/adaptors/adaptor_trait.h | 2 +-
sigc++/adaptors/bind.h | 2 +-
sigc++/adaptors/bind_return.h | 2 +-
sigc++/adaptors/track_obj.h | 2 +-
sigc++/functors/mem_fun.h | 4 ++--
sigc++/functors/ptr_fun.h | 3 +--
6 files changed, 7 insertions(+), 8 deletions(-)
---
diff --git a/sigc++/adaptors/adaptor_trait.h b/sigc++/adaptors/adaptor_trait.h
index a5b4442..e585dd3 100644
--- a/sigc++/adaptors/adaptor_trait.h
+++ b/sigc++/adaptors/adaptor_trait.h
@@ -90,7 +90,7 @@ struct adaptor_functor : public adaptor_base
decltype(auto) operator()() const { return functor_(); }
/** Invokes the wrapped functor passing on the arguments.
- * @param arg... Arguments to be passed on to the functor.
+ * @param arg Arguments to be passed on to the functor.
* @return The return value of the functor invocation.
*/
template <typename... T_arg>
diff --git a/sigc++/adaptors/bind.h b/sigc++/adaptors/bind.h
index 2accf27..8c4857c 100644
--- a/sigc++/adaptors/bind.h
+++ b/sigc++/adaptors/bind.h
@@ -271,7 +271,7 @@ struct visitor<bind_functor<-1, T_functor, T_type...>>
* position of the argument to be fixed (@p -1 stands for the last argument).
*
* @param func Functor that should be wrapped.
- * @param b1 Argument to bind to @e func.
+ * @param b Arguments to bind to @e func.
* @return Adaptor that executes @e func with the bound argument on invokation.
*
* @ingroup bind
diff --git a/sigc++/adaptors/bind_return.h b/sigc++/adaptors/bind_return.h
index ba6b101..44dcf96 100644
--- a/sigc++/adaptors/bind_return.h
+++ b/sigc++/adaptors/bind_return.h
@@ -43,7 +43,7 @@ struct bind_return_functor : public adapts<T_functor>
typename unwrap_reference<T_return>::type operator()();
/** Invokes the wrapped functor passing on the arguments.
- * @param a... Arguments to be passed on to the functor.
+ * @param a Arguments to be passed on to the functor.
* @return The fixed return value.
*/
template <typename... T_arg>
diff --git a/sigc++/adaptors/track_obj.h b/sigc++/adaptors/track_obj.h
index 740a417..9256011 100644
--- a/sigc++/adaptors/track_obj.h
+++ b/sigc++/adaptors/track_obj.h
@@ -86,7 +86,7 @@ public:
decltype(auto) operator()() { return this->functor_(); }
/** Invokes the wrapped functor passing on the arguments.
- * @param arg... Arguments to be passed on to the functor.
+ * @param arg Arguments to be passed on to the functor.
* @return The return value of the functor invocation.
*/
template <typename... T_arg>
diff --git a/sigc++/functors/mem_fun.h b/sigc++/functors/mem_fun.h
index 2408728..6808a39 100644
--- a/sigc++/functors/mem_fun.h
+++ b/sigc++/functors/mem_fun.h
@@ -108,7 +108,7 @@ public:
/** Execute the wrapped method operating on the passed instance.
* @param obj Reference to instance the method should operate on.
- * @param a... Argument to be passed on to the method.
+ * @param a Arguments to be passed on to the method.
* @return The return value of the method invocation.
*/
decltype(auto) operator()(obj_type_with_modifier& obj, type_trait_take_t<T_arg>... a) const
@@ -147,7 +147,7 @@ public:
}
/** Execute the wrapped method operating on the stored instance.
- * @param a... Argument to be passed on to the method.
+ * @param a Arguments to be passed on to the method.
* @return The return value of the method invocation.
*/
decltype(auto) operator()(type_trait_take_t<T_arg>... a) const
diff --git a/sigc++/functors/ptr_fun.h b/sigc++/functors/ptr_fun.h
index bfc137e..0bda77f 100644
--- a/sigc++/functors/ptr_fun.h
+++ b/sigc++/functors/ptr_fun.h
@@ -89,8 +89,7 @@ public:
explicit pointer_functor(function_type func) : func_ptr_(func) {}
/** Execute the wrapped function.
- * @param a1 Argument to be passed on to the function.
- * @param a2 Argument to be passed on to the function.
+ * @param a Arguments to be passed on to the function.
* @return The return value of the function invocation.
*/
T_return operator()(type_trait_take_t<T_args>... a) const { return func_ptr_(a...); }
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]