Fix documentation of get_config_path().

2021-05-20 10:03:09 +02:00 · 2021-05-20 10:03:09 +02:00 · f57555fb3a
commit f57555fb3a
parent 541a63dd73
1 changed files with 3 additions and 3 deletions
--- a/src/options.hpp
+++ b/src/options.hpp
@ -32,9 +32,9 @@ po::variables_map parse_options(int argc, char *argv[]);
 /*!
 *  @brief Returns the path of the config file.
 *
- *  Tries these paths: ${XDG_CONFIG_HOME}/epubgrep.conf
- *                     ${HOME}/.config/epubgrep.conf
- *                     epubgrep.conf
+ *  If XDG_CONFIG_HOME is set: ${XDG_CONFIG_HOME}/epubgrep.conf
+ *  If HOME is set:            ${HOME}/.config/epubgrep.conf
+ *  Otherwise:                 epubgrep.conf
 */
 std::string get_config_path();