Fix a bunch of docstrings
Clang correctly notes that a bunch of our docstrings are wrong. We
don't really use doxygen, but it's useful to be able to run a compiler
without warnings. The failures fall into a couple categories.
First, when using variadic templates, the type is the variable name (ie
T), not including variadic expansion. (ie T...). In these cases, the
... is removed from the definition.
Templatized structs should not use the @struct keyword. They are a
template as far as doxygen is concerned, so remove the keyword.
A number of functions docstrings are just wrong in terms of argument
names, or whether or not they have return types.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Iab6f76b422a9568b7ad19d3f725a9c1b870784d9
diff --git a/include/sdbusplus/asio/connection.hpp b/include/sdbusplus/asio/connection.hpp
index 2bb4880..444f79d 100644
--- a/include/sdbusplus/asio/connection.hpp
+++ b/include/sdbusplus/asio/connection.hpp
@@ -76,7 +76,8 @@
* upon return and return
*
* @param[in] m - A message ready to send
- * @param[in] token- The completion token to execute upon completion;
+ * @param[in] token - The completion token to execute upon completion;
+ * @param[in] timeout - The timeout in microseconds
*
*/
template <typename CompletionToken>
@@ -105,12 +106,8 @@
* @param[in] method - The object's method to call.
* @param[in] timeout - The timeout for the method call in usec (0 results
* in using the default value).
- * @param[in] a... - Optional parameters for the method call.
+ * @param[in] a - Optional parameters for the method call.
*
- * @return immediate return of the internal handler registration. The
- * result of the actual asynchronous call will get unpacked from
- * the message and passed into the handler when the call is
- * complete.
*/
template <typename MessageHandler, typename... InputArgs>
void async_method_call_timed(MessageHandler&& handler,
@@ -197,12 +194,8 @@
* @param[in] objpath - The object's path for the call.
* @param[in] interf - The object's interface to call.
* @param[in] method - The object's method to call.
- * @param[in] a... - Optional parameters for the method call.
+ * @param[in] a - Optional parameters for the method call.
*
- * @return immediate return of the internal handler registration. The
- * result of the actual asynchronous call will get unpacked from
- * the message and passed into the handler when the call is
- * complete.
*/
template <typename MessageHandler, typename... InputArgs>
void async_method_call(MessageHandler&& handler, const std::string& service,
@@ -224,7 +217,7 @@
* @param[in] objpath - The object's path for the call.
* @param[in] interf - The object's interface to call.
* @param[in] method - The object's method to call.
- * @param[in] a... - Optional parameters for the method call.
+ * @param[in] a - Optional parameters for the method call.
*
* @return Unpacked value of RetType
*/