X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3b88355f59ffadc66f5f76816d4732a607702fc6..7df4c51f6021fbf1b204db918a1cc5c4ddff31cc:/docs/doxygen/overviews/file.h diff --git a/docs/doxygen/overviews/file.h b/docs/doxygen/overviews/file.h index b158cf3bbf..59aad759d4 100644 --- a/docs/doxygen/overviews/file.h +++ b/docs/doxygen/overviews/file.h @@ -6,27 +6,27 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// -/*! +/** - @page overview_file File classes and functions overview + @page overview_file File Classes and Functions - Classes: #wxFile, #wxDir, #wxTempFile, #wxTextFile + Classes: wxFile, wxDir, wxTempFile, wxTextFile - Functions: see @ref filefunctions_overview. + Functions: see @ref page_func_cat_file. wxWidgets provides some functions and classes to facilitate working with files. As usual, the accent is put on cross-platform features which explains, for - example, the #wxTextFile class which may be used to convert + example, the wxTextFile class which may be used to convert between different types of text files (DOS/Unix/Mac). wxFile may be used for low-level IO. It contains all the usual functions to work with files (opening/closing, reading/writing, seeking, and so on) but compared with using standard C functions, has error checking (in case of an error a message - is logged using #wxLog facilities) and closes the file + is logged using wxLog facilities) and closes the file automatically in the destructor which may be quite convenient. wxTempFile is a very small file designed to make replacing the files contents - safer - see its #documentation for more details. + safer - see its documentation for more details. wxTextFile is a general purpose class for working with small text files on line by line basis. It is especially well suited for working with configuration files