| 修订版 | cc67a4e5aaeed15548afb5d7a90c5a8fbadbdc41 (tree) |
|---|---|
| 时间 | 2016-12-20 01:57:29 |
| 作者 |  LoRd_MuldeR <mulder2@gmx....> |
| Commiter | LoRd_MuldeR |
Small documentation fix.
docs/d5/d3b/_global_8h.html (diff)
include/MUtils/Global.h (diff)| @@ -301,7 +301,7 @@ QString </td><td class="memItemRight" valign="bottom"><b>MUtils::clean_file | ||
| 301 | 301 | <tr><td class="paramname">basePath</td><td>Specifies the "base" directory where the unique file is supposed to be created. This must be a valid <em>existing</em> directory.</td></tr> |
| 302 | 302 | <tr><td class="paramname">baseName</td><td>Specifies the desired "base" file name of the unique file. Do <b>not</b> include a file extension.</td></tr> |
| 303 | 303 | <tr><td class="paramname">extension</td><td>Specifies the desired file extensions of the unique file. Do <b>not</b> include a leading dot (<code>.</code>) character.</td></tr> |
| 304 | - <tr><td class="paramname">fancy</td><td>If set to <code>true</code>, the file name is generated according to the <code>"<basedir>/<basename> (N).<ext>"</code> pattern; if set to <code>false</code>, the file name is generated according to the <code>"<basedir>/<basename>.XXXX.<ext>"</code> pattern.</td></tr> | |
| 304 | + <tr><td class="paramname">fancy</td><td>If set to <code>true</code>, the unique file name is generated according to the <code>"<basedir>/<basename> (N).<ext>"</code> pattern; if set to <code>false</code>, it is generated according to the <code>"<basedir>/<basename>.XXXX.<ext>"</code> pattern. Also, if set to <code>true</code>, a counter is only included in the file name, if the file name <em>without</em> counter already exists; if set to <code>false</code>, a counter is always included. Finally, if set to <code>true</code>, the counter starts at <b>2</b> and is printed in decimal format; if set to <code>false</code>, the counter starts at <b>0</b> and is printed in zero-padded hexadecimal format.</td></tr> | |
| 305 | 305 | </table> |
| 306 | 306 | </dd> |
| 307 | 307 | </dl> |
| @@ -144,7 +144,7 @@ namespace MUtils | ||
| 144 | 144 | * |
| 145 | 145 | * \param extension Specifies the desired file extensions of the unique file. Do **not** include a leading dot (`.`) character. |
| 146 | 146 | * |
| 147 | - * \param fancy If 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. | |
| 147 | + * \param fancy If 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. | |
| 148 | 148 | * |
| 149 | 149 | * \return If the function succeeds, it returns a QString holding the full path of the unique file; otherwise it returns a default-constructed QString. |
| 150 | 150 | */ |
Fork