Minor Doxygen comment cosmetics.
authorUwe Hermann <uwe@hermann-uwe.de>
Mon, 26 Jun 2017 20:06:23 +0000 (22:06 +0200)
committerUwe Hermann <uwe@hermann-uwe.de>
Tue, 27 Jun 2017 11:21:19 +0000 (13:21 +0200)
pv/devicemanager.cpp
pv/session.cpp
pv/util.cpp

index 15e791e128eb8e542ec705459be51d4ec41dd5ba..35efa12786bb524003bbdbe0ff4eecf54d59927e 100644 (file)
@@ -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<const ConfigKey *, Glib::VariantBase>
 DeviceManager::drive_scan_options(vector<string> user_spec,
index 516e1acd5ad6ff1e6b52a277f97c042e28e37872..00eb7ad0142716e6eac7aaf4749f694ecd9cdfe5 100644 (file)
@@ -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<string, Glib::VariantBase>
 Session::input_format_options(vector<string> user_spec,
index a452aac4b6eaef7e51f85b9cd6d0b0f37f7b5e19..6424a9b1b5893b13d212ad1deef61221bea30aef 100644 (file)
@@ -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<string> split_string(string text, string separator)
 {