X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..d29a9a8ac8ab0467c8a3c076b147a0942011f7ee:/interface/file.h diff --git a/interface/file.h b/interface/file.h index 898d0af608..cb74e2dfa8 100644 --- a/interface/file.h +++ b/interface/file.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: file.h -// Purpose: documentation for wxTempFile class +// Purpose: interface of wxTempFile // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -119,6 +119,7 @@ public: }; + /** @class wxFile @wxheader{file.h} @@ -146,7 +147,7 @@ public: /** Associates the file with the given file descriptor, which has already been opened. - + @param filename The filename. @param mode @@ -164,7 +165,7 @@ public: /** 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(); @@ -253,7 +254,7 @@ public: /** Opens the file, returning @true if successful. - + @param filename The filename. @param mode @@ -274,13 +275,13 @@ public: /** Seeks to the specified position. - + @param ofs Offset to seek to. @param mode One of wxFromStart, wxFromEnd, wxFromCurrent. - - @returns The actual offset position achieved, or wxInvalidOffset on + + @return The actual offset position achieved, or wxInvalidOffset on failure. */ wxFileOffset Seek(wxFileOffset ofs, @@ -290,11 +291,11 @@ 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. - + @param ofs Number of bytes before the end of the file. - - @returns The actual offset position achieved, or wxInvalidOffset on + + @return The actual offset position achieved, or wxInvalidOffset on failure. */ wxFileOffset SeekEnd(wxFileOffset ofs = 0); @@ -321,3 +322,4 @@ public: */ int fd() const; }; +