fix various Doxygen errors (#9568)

[wxWidgets.git] / interface / ffile.h

diff --git a/interface/ffile.h b/interface/ffile.h
index 4f97fa6aea8e95173d35cbbfaa2bafe49539d52b..a19619ff9af104253768462fcd47148c1459e71e 100644 (file)
--- a/interface/ffile.h
+++ b/interface/ffile.h
@@ -6,15 +6,43 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

+
+
+/**
+    Values used for both wxFile and wxFFile.
+
+    @todo make the value names uppercase
+*/
+enum wxSeekMode
+{
+  wxFromStart,
+  wxFromCurrent,
+  wxFromEnd
+};
+
+/**
+    See wxFFile::GetKind().
+*/
+enum wxFileKind
+{
+  wxFILE_KIND_UNKNOWN,
+  wxFILE_KIND_DISK,     /**< A file supporting seeking to arbitrary offsets. */
+  wxFILE_KIND_TERMINAL, /**< A terminal. */
+  wxFILE_KIND_PIPE      /**< A pipe. */
+};
+
+

 /**
     @class wxFFile
     @wxheader{ffile.h}
 
 /**
     @class wxFFile
     @wxheader{ffile.h}
 

-    wxFFile implements buffered file I/O. This is a very small class designed to
-    minimize the overhead of using it - in fact, there is hardly any overhead at
-    all, but using it brings you automatic error checking and hides differences
-    between platforms and compilers. It wraps inside it a @c FILE * handle used
-    by standard C IO library (also known as @c stdio).
+    wxFFile implements buffered file I/O.
+
+    This is a very small class designed to minimize the overhead of using it - in fact,
+    there is hardly any overhead at all, but using it brings you automatic error checking
+    and hides differences between platforms and compilers.
+
+    It wraps inside it a @c FILE * handle used by standard C IO library (also known as @c stdio).

 
     @library{wxbase}
     @category{file}
 
     @library{wxbase}
     @category{file}


@@ -24,10 +52,22 @@
 class wxFFile
 {
 public:
 class wxFFile
 {
 public:

-    //@{
+    wxFFile();
+

     /**
         Opens a file with the given file pointer, which has already been opened.
 
     /**
         Opens a file with the given file pointer, which has already been opened.
 

+        @param fp
+            An existing file descriptor, such as stderr.
+    */
+    wxFFile(FILE* fp);
+
+    /**
+        Opens a file with the given mode.
+        As there is no way to return whether the operation was successful or not from
+        the constructor you should test the return value of IsOpened() to check that it
+        didn't fail.
+

         @param filename
             The filename.
         @param mode
         @param filename
             The filename.
         @param mode


@@ -35,24 +75,21 @@ public:
             Note that you should use "b" flag if you use binary files under Windows
             or the results might be unexpected due to automatic newline conversion done
             for the text files.
             Note that you should use "b" flag if you use binary files under Windows
             or the results might be unexpected due to automatic newline conversion done
             for the text files.

-        @param fp
-            An existing file descriptor, such as stderr.

     */
     */

-    wxFFile();

     wxFFile(const wxString& filename, const wxString& mode = "r");
     wxFFile(const wxString& filename, const wxString& mode = "r");

-    wxFFile(FILE* fp);
-    //@}
+

 
     /**
         Destructor will close the file.
 
     /**
         Destructor will close the file.

-        NB: it is not virtual so you should @e not derive from wxFFile!
+
+        @note it is not virtual so you should @e not derive from wxFFile!

     */
     ~wxFFile();
 
     /**
         Attaches an existing file pointer to the wxFFile object.
     */
     ~wxFFile();
 
     /**
         Attaches an existing file pointer to the wxFFile object.

-        The descriptor should be already opened and it will be closed by wxFFile
-        object.
+
+        The descriptor should be already opened and it will be closed by wxFFile object.

     */
     void Attach(FILE* fp);
 
     */
     void Attach(FILE* fp);
 


@@ -63,21 +100,24 @@ public:
 
     /**
         Get back a file pointer from wxFFile object -- the caller is responsible for
 
     /**
         Get back a file pointer from wxFFile object -- the caller is responsible for

-        closing the file if this
-        descriptor is opened. IsOpened() will return @false after call to Detach().
+        closing the file if this descriptor is opened.
+
+        IsOpened() will return @false after call to Detach().

     */
     void Detach();
 
     /**
         Returns @true if the an attempt has been made to read @e past
         the end of the file.
     */
     void Detach();
 
     /**
         Returns @true if the an attempt has been made to read @e past
         the end of the file.

-        Note that the behaviour of the file descriptor based class
-        wxFile is different as wxFile::Eof
-        will return @true here as soon as the last byte of the file has been
-        read.
+
+        Note that the behaviour of the file descriptor based class  wxFile is different as
+        wxFile::Eof() will return @true here as soon as the last byte of the file has been read.
+

         Also note that this method may only be called for opened files and may crash if
         the file is not opened.
 
         Also note that this method may only be called for opened files and may crash if
         the file is not opened.
 

+        @todo THIS METHOD MAY CRASH? DOESN'T SOUND GOOD
+

         @see IsOpened()
     */
     bool Eof() const;
         @see IsOpened()
     */
     bool Eof() const;


@@ -85,12 +125,15 @@ public:
     /**
         Returns @true if an error has occurred on this file, similar to the standard
         @c ferror() function.
     /**
         Returns @true if an error has occurred on this file, similar to the standard
         @c ferror() function.

+

         Please note that this method may only be called for opened files and may crash
         if the file is not opened.
 
         Please note that this method may only be called for opened files and may crash
         if the file is not opened.
 

+        @todo THIS METHOD MAY CRASH? DOESN'T SOUND GOOD
+

         @see IsOpened()
     */
         @see IsOpened()
     */

-
+    bool Error() const;

 
     /**
         Flushes the file and returns @true on success.
 
     /**
         Flushes the file and returns @true on success.


@@ -98,14 +141,16 @@ public:
     bool Flush();
 
     /**
     bool Flush();
 
     /**

-        Returns the type of the file. Possible return values are:
+        Returns the type of the file.
+
+        @see wxFileKind

     */
     wxFileKind GetKind() const;
 
     /**
     */
     wxFileKind GetKind() const;
 
     /**

-        Returns @true if the file is opened. Most of the methods of this class may
-        only
-        be used for an opened file.
+        Returns @true if the file is opened.
+
+        Most of the methods of this class may only be used for an opened file.

     */
     bool IsOpened() const;
 
     */
     bool IsOpened() const;
 


@@ -125,20 +170,18 @@ public:
     bool Open(const wxString& filename, const wxString& mode = "r");
 
     /**
     bool Open(const wxString& filename, const wxString& mode = "r");
 
     /**

-        Reads the specified number of bytes into a buffer, returning the actual number
-        read.
+        Reads the specified number of bytes into a buffer, returning the actual number read.

 
         @param buffer
             A buffer to receive the data.
         @param count
             The number of bytes to read.
 
 
         @param buffer
             A buffer to receive the data.
         @param count
             The number of bytes to read.
 

-        @returns The number of bytes read.
+        @return The number of bytes read.

     */
     size_t Read(void* buffer, size_t count);
 
     /**
     */
     size_t Read(void* buffer, size_t count);
 
     /**

-        )

         Reads the entire contents of the file into a string.
 
         @param str
         Reads the entire contents of the file into a string.
 
         @param str


@@ -147,9 +190,9 @@ public:
             Conversion object to use in Unicode build; by default supposes
             that file contents is encoded in UTF-8.
 
             Conversion object to use in Unicode build; by default supposes
             that file contents is encoded in UTF-8.
 

-        @returns @true if file was read successfully, @false otherwise.
+        @return @true if file was read successfully, @false otherwise.

     */
     */

-    bool ReadAll(wxString* str);
+    bool ReadAll(wxString* str, const wxMBConv& conv = wxConvAuto());

 
     /**
         Seeks to the specified position and returns @true on success.
 
     /**
         Seeks to the specified position and returns @true on success.


@@ -163,8 +206,7 @@ public:
 
     /**
         Moves the file pointer to the specified number of bytes before the end of the
 
     /**
         Moves the file pointer to the specified number of bytes before the end of the

-        file
-        and returns @true on success.
+        file and returns @true on success.

 
         @param ofs
             Number of bytes before the end of the file.
 
         @param ofs
             Number of bytes before the end of the file.


@@ -177,12 +219,24 @@ public:
     wxFileOffset Tell() const;
 
     /**
     wxFileOffset Tell() const;
 
     /**

-        )

         Writes the contents of the string to the file, returns @true on success.
         Writes the contents of the string to the file, returns @true on success.

+

         The second argument is only meaningful in Unicode build of wxWidgets when
         The second argument is only meaningful in Unicode build of wxWidgets when

-        @e conv is used to convert @a s to multibyte representation.
+        @a conv is used to convert @a str to multibyte representation.
+    */
+    bool Write(const wxString& str, const wxMBConv& conv = wxConvAuto());
+
+    /**
+        Writes the specified number of bytes from a buffer.
+
+        @param buffer
+            A buffer containing the data.
+        @param count
+            The number of bytes to write.
+
+        @return The number of bytes written.

     */
     */

-    bool Write(const wxString& s);
+    size_t Write(const void* buffer, size_t count);

 
     /**
         Returns the file pointer associated with the file.
 
     /**
         Returns the file pointer associated with the file.