undo the last change as it results in buildbot configuration error

[wxWidgets.git] / interface / wx / filefn.h

diff --git a/interface/wx/filefn.h b/interface/wx/filefn.h
index dc9bb6d47bfd7937e122f70acc50b11f8159865a..1080f8f540b15fd421cf23b4fbbde362cc65cc0f 100644 (file)
--- a/interface/wx/filefn.h
+++ b/interface/wx/filefn.h
@@ -98,7 +98,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */
 //@{
 
 /**
@@ -107,6 +107,15 @@ public:
 */
 const int wxInvalidOffset = -1;
 
+/**
+    The type used to store and provide byte offsets or byte sizes for files or streams.
+
+    It is type-defined as @c off_t on POSIX platforms
+    (see http://www.gnu.org/software/libc/manual/html_node/File-Position-Primitive.html)
+    or to @c wxLongLong_t on Windows when @c wxHAS_HUGE_FILES is defined.
+*/
+typedef off_t wxFileOffset;
+
 /**
     Under Unix this macro changes the current process umask to the given value,
     unless it is equal to -1 in which case nothing is done, and restores it to
@@ -168,16 +177,22 @@ int wxParseCommonDialogsFilter(const wxString& wildCard,
     Converts a DOS to a Unix filename by replacing backslashes with forward
     slashes.
 
+    @deprecated
+        Construct a wxFileName with wxPATH_DOS and then use
+        wxFileName::GetFullPath(wxPATH_UNIX) instead.
+
     @header{wx/filefn.h}
 */
 void wxDos2UnixFilename(wxChar* s);
 
 /**
-    @warning This function is deprecated, use wxFileName instead.
-
     Converts a Unix to a DOS filename by replacing forward slashes with
     backslashes.
 
+    @deprecated
+        Construct a wxFileName with wxPATH_UNIX and then use
+        wxFileName::GetFullPath(wxPATH_DOS) instead.
+
     @header{wx/filefn.h}
 */
 void wxUnix2DosFilename(wxChar* s);
@@ -190,8 +205,8 @@ void wxUnix2DosFilename(wxChar* s);
 bool wxDirExists(const wxString& dirname);
 
 /**
-    @warning This function is obsolete, please use wxFileName::SplitPath()
-             instead.
+    @deprecated
+        This function is obsolete, please use wxFileName::SplitPath() instead.
 
     This function splits a full file name into components: the path (including
     possible disk/drive specification under Windows), the base name, and the
@@ -274,7 +289,7 @@ bool wxMatchWild(const wxString& pattern,
                   bool dot_special);
 
 /**
-    @warning This function is deprecated, use wxGetCwd() instead.
+    @deprecated This function is deprecated, use wxGetCwd() instead.
 
     Copies the current working directory into the buffer if supplied, or copies
     the working directory into new storage (which you must delete yourself) if
@@ -422,7 +437,7 @@ enum wxFileKind
 
 //@}
 
-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */
 //@{
 /**
     Returns the type of an open file. Possible return values are enumerations
@@ -434,11 +449,11 @@ wxFileKind wxGetFileKind(int fd);
 wxFileKind wxGetFileKind(FILE* fp);
 //@}
 
-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */
 //@{
 /**
-    @warning This function is obsolete, please use wxFileName::SplitPath()
-             instead.
+    @deprecated
+        This function is obsolete, please use wxFileName::SplitPath() instead.
 
     Returns the filename for a full path. The second form returns a pointer to
     temporary storage that should not be deallocated.
@@ -449,11 +464,11 @@ wxString wxFileNameFromPath(const wxString& path);
 char* wxFileNameFromPath(char* path);
 //@}
 
-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */
 //@{
 /**
-    @warning This function is obsolete, please use
-             wxFileName::CreateTempFileName() instead.
+    @deprecated
+        This function is obsolete, please use wxFileName::CreateTempFileName() instead.
 
     @header{wx/filefn.h}
 */