From 3083cda853bd12d73b741c3bc97b70f5d395a15a Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Mon, 26 Jun 2017 22:06:23 +0200 Subject: [PATCH] Minor Doxygen comment cosmetics. --- pv/devicemanager.cpp | 6 +++--- pv/session.cpp | 6 +++--- pv/util.cpp | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/pv/devicemanager.cpp b/pv/devicemanager.cpp index 15e791e1..35efa127 100644 --- a/pv/devicemanager.cpp +++ b/pv/devicemanager.cpp @@ -170,10 +170,10 @@ DeviceManager::user_spec_device() const /** * Convert generic options to data types that are specific to Driver::scan(). * - * @param[in] user_spec vector of tokenized words, string format - * @param[in] driver_opts driver's scan options, result of Driver::scan_options() + * @param[in] user_spec Vector of tokenized words, string format. + * @param[in] driver_opts Driver's scan options, result of Driver::scan_options(). * - * @return map of options suitable for Driver::scan() + * @return Map of options suitable for Driver::scan(). */ map DeviceManager::drive_scan_options(vector user_spec, diff --git a/pv/session.cpp b/pv/session.cpp index 516e1acd..00eb7ad0 100644 --- a/pv/session.cpp +++ b/pv/session.cpp @@ -437,10 +437,10 @@ void Session::set_default_device() /** * Convert generic options to data types that are specific to InputFormat. * - * @param[in] user_spec vector of tokenized words, string format - * @param[in] fmt_opts input format's options, result of InputFormat::options() + * @param[in] user_spec Vector of tokenized words, string format. + * @param[in] fmt_opts Input format's options, result of InputFormat::options(). * - * @return map of options suitable for InputFormat::create_input() + * @return Map of options suitable for InputFormat::create_input(). */ map Session::input_format_options(vector user_spec, diff --git a/pv/util.cpp b/pv/util.cpp index a452aac4..6424a9b1 100644 --- a/pv/util.cpp +++ b/pv/util.cpp @@ -225,12 +225,12 @@ QString format_time_minutes(const Timestamp& t, signed precision, bool sign) } /** - * Split a string into tokens at occurances of the separator. + * Split a string into tokens at occurences of the separator. * - * @param[in] text the input string to split - * @param[in] separator the delimiter between tokens + * @param[in] text The input string to split. + * @param[in] separator The delimiter between tokens. * - * @return a vector of broken down tokens + * @return A vector of broken down tokens. */ vector split_string(string text, string separator) { -- 2.30.2