From cc67a4e5aaeed15548afb5d7a90c5a8fbadbdc41 Mon Sep 17 00:00:00 2001 From: LoRd_MuldeR Date: Mon, 19 Dec 2016 17:57:29 +0100 Subject: [PATCH] Small documentation fix. --- docs/d5/d3b/_global_8h.html | 2 +- include/MUtils/Global.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/d5/d3b/_global_8h.html b/docs/d5/d3b/_global_8h.html index a1337ff..6fe6dbf 100644 --- a/docs/d5/d3b/_global_8h.html +++ b/docs/d5/d3b/_global_8h.html @@ -301,7 +301,7 @@ QString MUtils::clean_file basePathSpecifies the "base" directory where the unique file is supposed to be created. This must be a valid existing directory. baseNameSpecifies the desired "base" file name of the unique file. Do not include a file extension. extensionSpecifies the desired file extensions of the unique file. Do not include a leading dot (.) character. - fancyIf set to true, the file name is generated according to the "<basedir>/<basename> (N).<ext>" pattern; if set to false, the file name is generated according to the "<basedir>/<basename>.XXXX.<ext>" pattern. + fancyIf set to true, the unique file name is generated according to the "<basedir>/<basename> (N).<ext>" pattern; if set to false, it is generated according to the "<basedir>/<basename>.XXXX.<ext>" pattern. Also, if set to true, a counter is only included in the file name, if the file name without counter already exists; if set to false, a counter is always included. Finally, if set to true, the counter starts at 2 and is printed in decimal format; if set to false, the counter starts at 0 and is printed in zero-padded hexadecimal format. diff --git a/include/MUtils/Global.h b/include/MUtils/Global.h index 4a577c8..4e4f06a 100644 --- a/include/MUtils/Global.h +++ b/include/MUtils/Global.h @@ -144,7 +144,7 @@ namespace MUtils * * \param extension Specifies the desired file extensions of the unique file. Do **not** include a leading dot (`.`) character. * - * \param fancy If set to `true`, the file name is generated according to the `"/ (N)."` pattern; if set to `false`, the file name is generated according to the `"/.XXXX."` pattern. + * \param fancy If set to `true`, the unique file name is generated according to the `"/ (N)."` pattern; if set to `false`, it is generated according to the `"/.XXXX."` pattern. Also, if set to `true`, a counter is only included in the file name, if the file name *without* counter already exists; if set to `false`, a counter is always included. Finally, if set to `true`, the counter starts at **2** and is printed in decimal format; if set to `false`, the counter starts at **0** and is printed in zero-padded hexadecimal format. * * \return If the function succeeds, it returns a QString holding the full path of the unique file; otherwise it returns a default-constructed QString. */