115% line height on lists is more than enough, especially for the class hierarchy...

[wxWidgets.git] / interface / file.h

diff --git a/interface/file.h b/interface/file.h
index 69b44b3934f13904f418e1639e1e9049368daf6f..7ece7ce26e0cb61fa699881770a0ceae9c381193 100644 (file)
--- a/interface/file.h
+++ b/interface/file.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        file.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        file.h

-// Purpose:     documentation for wxTempFile class
+// Purpose:     interface of wxTempFile

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -79,20 +79,19 @@ public:
     /**
         Returns @true if the file was successfully opened.
     */
     /**
         Returns @true if the file was successfully opened.
     */

-    bool IsOpened();
+    bool IsOpened() const;

 
     /**
         Returns the length of the file.
     */
 
     /**
         Returns the length of the file.
     */

-    wxFileOffset Length();
+    wxFileOffset Length() const;

 
     /**
         Open the temporary file, returns @true on success, @false if an error
         occurred.
 
     /**
         Open the temporary file, returns @true on success, @false if an error
         occurred.

-        
-        @e strName is the name of file to be replaced. The temporary file is always
-        created in the directory where @e strName is. In particular, if
-        @e strName doesn't include the path, it is created in the current directory
+        @a strName is the name of file to be replaced. The temporary file is always
+        created in the directory where @a strName is. In particular, if
+        @a strName doesn't include the path, it is created in the current directory

         and the program should have write access to it for the function to succeed.
     */
     bool Open(const wxString& strName);
         and the program should have write access to it for the function to succeed.
     */
     bool Open(const wxString& strName);


@@ -108,19 +107,19 @@ public:
         another
         error occurred.
     */
         another
         error occurred.
     */

-    wxFileOffset Tell();
+    wxFileOffset Tell() const;

 
     /**
         Write to the file, return @true on success, @false on failure.
 
     /**
         Write to the file, return @true on success, @false on failure.

-        

         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 @e str to multibyte representation.
+        @a conv is used to convert @a str to multibyte representation.

     */
     bool Write(const wxString& str,
                const wxMBConv& conv = wxConvUTF8);
 };
 
 
     */
     bool Write(const wxString& str,
                const wxMBConv& conv = wxConvUTF8);
 };
 
 

+

 /**
     @class wxFile
     @wxheader{file.h}
 /**
     @class wxFile
     @wxheader{file.h}


@@ -148,16 +147,14 @@ public:
     /**
         Associates the file with the given file descriptor, which has already been
         opened.
     /**
         Associates the file with the given file descriptor, which has already been
         opened.

-        
+

         @param filename
         @param filename

-        The filename.
-        
+            The filename.

         @param mode
         @param mode

-        The mode in which to open the file. May be one of read(), write() and
+            The mode in which to open the file. May be one of read(), write() and

         wxFile::read_write.
         wxFile::read_write.

-        

         @param fd
         @param fd

-        An existing file descriptor (see Attach() for the list of predefined
+            An existing file descriptor (see Attach() for the list of predefined

         descriptors)
     */
     wxFile();
         descriptors)
     */
     wxFile();


@@ -168,8 +165,7 @@ public:
 
     /**
         Destructor will close the file.
 
     /**
         Destructor will close the file.

-        
-        @b NB: it is not virtual so you should not use wxFile polymorphically.
+        @note it is not virtual so you should not use wxFile polymorphically.

     */
     ~wxFile();
 
     */
     ~wxFile();
 


@@ -185,7 +181,6 @@ public:
         (and
         have symbolic names of @b wxFile::fd_stdin, @b wxFile::fd_stdout and @b
         wxFile::fd_stderr).
         (and
         have symbolic names of @b wxFile::fd_stdin, @b wxFile::fd_stdout and @b
         wxFile::fd_stderr).

-        

         The descriptor should be already opened and it will be closed by wxFile
         object.
     */
         The descriptor should be already opened and it will be closed by wxFile
         object.
     */


@@ -201,7 +196,7 @@ public:
         @true
         will ensure it is overwritten.
     */
         @true
         will ensure it is overwritten.
     */

-    bool Create(const wxString& filename, bool overwrite = @false,
+    bool Create(const wxString& filename, bool overwrite = false,

                 int access = wxS_DEFAULT);
 
     /**
                 int access = wxS_DEFAULT);
 
     /**


@@ -213,14 +208,12 @@ public:
 
     /**
         Returns @true if the end of the file has been reached.
 
     /**
         Returns @true if the end of the file has been reached.

-        

         Note that the behaviour of the file pointer based class
         wxFFile is different as wxFFile::Eof
         will return @true here only if an attempt has been made to read
         @e past the last byte of the file, while wxFile::Eof() will return @true
         even before such attempt is made if the file pointer is at the last position
         in the file.
         Note that the behaviour of the file pointer based class
         wxFFile is different as wxFFile::Eof
         will return @true here only if an attempt has been made to read
         @e past the last byte of the file, while wxFile::Eof() will return @true
         even before such attempt is made if the file pointer is at the last position
         in the file.

-        

         Note also that this function doesn't work on unseekable file descriptors
         (examples include pipes, terminals and sockets under Unix) and an attempt to
         use it will result in an error message in such case. So, to read the entire
         Note also that this function doesn't work on unseekable file descriptors
         (examples include pipes, terminals and sockets under Unix) and an attempt to
         use it will result in an error message in such case. So, to read the entire


@@ -228,7 +221,7 @@ public:
         Read() repeatedly and tests its return condition instead
         of using Eof() as this will not work for special files under Unix.
     */
         Read() repeatedly and tests its return condition instead
         of using Eof() as this will not work for special files under Unix.
     */

-#define bool Eof()     /* implementation is private */
+    bool Eof() const;

 
     /**
         Returns @true if the given name specifies an existing regular file (not a
 
     /**
         Returns @true if the given name specifies an existing regular file (not a


@@ -238,7 +231,6 @@ public:
 
     /**
         Flushes the file descriptor.
 
     /**
         Flushes the file descriptor.

-        

         Note that Flush() is not implemented on some Windows compilers
         due to a missing fsync function, which reduces the usefulness of this function
         (it can still be called but it will do nothing on unsupported compilers).
         Note that Flush() is not implemented on some Windows compilers
         due to a missing fsync function, which reduces the usefulness of this function
         (it can still be called but it will do nothing on unsupported compilers).


@@ -248,26 +240,25 @@ public:
     /**
         Returns the type of the file. Possible return values are:
     */
     /**
         Returns the type of the file. Possible return values are:
     */

-    wxFileKind GetKind();
+    wxFileKind GetKind() const;

 
     /**
         Returns @true if the file has been opened.
     */
 
     /**
         Returns @true if the file has been opened.
     */

-    bool IsOpened();
+    bool IsOpened() const;

 
     /**
         Returns the length of the file.
     */
 
     /**
         Returns the length of the file.
     */

-    wxFileOffset Length();
+    wxFileOffset Length() const;

 
     /**
         Opens the file, returning @true if successful.
 
     /**
         Opens the file, returning @true if successful.

-        
+

         @param filename
         @param filename

-        The filename.
-        
+            The filename.

         @param mode
         @param mode

-        The mode in which to open the file. May be one of read(), write() and
+            The mode in which to open the file. May be one of read(), write() and

         wxFile::read_write.
     */
     bool Open(const wxString& filename,
         wxFile::read_write.
     */
     bool Open(const wxString& filename,


@@ -284,15 +275,14 @@ public:
 
     /**
         Seeks to the specified position.
 
     /**
         Seeks to the specified position.

-        
+

         @param ofs
         @param ofs

-        Offset to seek to.
-        
+            Offset to seek to.

         @param mode
         @param mode

-        One of wxFromStart, wxFromEnd, wxFromCurrent.
-        
+            One of wxFromStart, wxFromEnd, wxFromCurrent.
+

         @returns The actual offset position achieved, or wxInvalidOffset on
         @returns The actual offset position achieved, or wxInvalidOffset on

-                   failure.
+                 failure.

     */
     wxFileOffset Seek(wxFileOffset ofs,
                       wxSeekMode mode = wxFromStart);
     */
     wxFileOffset Seek(wxFileOffset ofs,
                       wxSeekMode mode = wxFromStart);


@@ -301,12 +291,12 @@ public:
         Moves the file pointer to the specified number of bytes relative to the end of
         the file. For example, @c SeekEnd(-5) would position the pointer 5
         bytes before the end.
         Moves the file pointer to the specified number of bytes relative to the end of
         the file. For example, @c SeekEnd(-5) would position the pointer 5
         bytes before the end.

-        
+

         @param ofs
         @param ofs

-        Number of bytes before the end of the file.
-        
+            Number of bytes before the end of the file.
+

         @returns The actual offset position achieved, or wxInvalidOffset on
         @returns The actual offset position achieved, or wxInvalidOffset on

-                   failure.
+                 failure.

     */
     wxFileOffset SeekEnd(wxFileOffset ofs = 0);
 
     */
     wxFileOffset SeekEnd(wxFileOffset ofs = 0);
 


@@ -315,14 +305,12 @@ public:
         another
         error occurred.
     */
         another
         error occurred.
     */

-    wxFileOffset Tell();
+    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 @e s to multibyte representation.
-        
+        @a conv is used to convert @a s to multibyte representation.

         Note that this method only works with @c NUL-terminated strings, if you want
         to write data with embedded @c NULs to the file you should use the other
         @ref write() "Write() overload".
         Note that this method only works with @c NUL-terminated strings, if you want
         to write data with embedded @c NULs to the file you should use the other
         @ref write() "Write() overload".


@@ -332,5 +320,6 @@ public:
     /**
         Returns the file descriptor associated with the file.
     */
     /**
         Returns the file descriptor associated with the file.
     */

-#define int fd()     /* implementation is private */
+    int fd() const;

 };
 };

+