X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c4f71cc3d63fb7bdfbd6cec3e39c8a8679f3e60..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/filename.h diff --git a/interface/filename.h b/interface/filename.h index 6e26cbfe37..429cee3a8b 100644 --- a/interface/filename.h +++ b/interface/filename.h @@ -178,7 +178,7 @@ public: @param fileTemp The file to open or @NULL to just get the name - @returns The full temporary file name or an empty string on error. + @return The full temporary file name or an empty string on error. */ static wxString CreateTempFileName(const wxString& prefix, wxFile* fileTemp = NULL); @@ -333,7 +333,7 @@ public: the volume is empty, the program's current working directory is returned for the current volume. - @returns The string containing the current working directory or an empty + @return The string containing the current working directory or an empty string on error. @see AssignCwd() @@ -511,7 +511,7 @@ public: Any of the pointers may be @NULL if the corresponding time is not needed. - @returns @true on success, @false if we failed to retrieve the times. + @return @true on success, @false if we failed to retrieve the times. */ bool GetTimes(wxDateTime* dtAccess, wxDateTime* dtMod, wxDateTime* dtCreate) const; @@ -681,7 +681,7 @@ public: @param format the file name format, native by default - @returns @true if the file name has been changed, @false if we failed to do + @return @true if the file name has been changed, @false if we failed to do anything with it (currently this only happens if the file name is on a volume different from the volume specified by pathBase). @@ -702,7 +702,7 @@ public: try to create each directory in the path and also don't return an error if the target directory already exists. - @returns Returns @true if the directory was successfully created, @false + @return Returns @true if the directory was successfully created, @false otherwise. */ bool Mkdir(int perm = 0777, int flags = 0); @@ -814,7 +814,7 @@ public: @param format The file name format to use when processing the paths, native by default. - @returns @true if normalization was successfully or @false otherwise. + @return @true if normalization was successfully or @false otherwise. */ bool Normalize(int flags = wxPATH_NORM_ALL, const wxString& cwd = wxEmptyString, @@ -936,7 +936,7 @@ public: without leading dot. All three of them may be empty if the corresponding component is. The old contents of the strings pointed to by these parameters will be overwritten in any case (if the pointers are not @NULL). - Note that for a filename "foo.'' the extension is present, as indicated by the + Note that for a filename "foo." the extension is present, as indicated by the trailing dot, but empty. If you need to cope with such cases, you should use @a hasExt instead of relying on testing whether @a ext is empty or not. */