Use flat generic status bar by default and add wxSB_SUNKEN.

[wxWidgets.git] / docs / doxygen / overviews / file.h

diff --git a/docs/doxygen/overviews/file.h b/docs/doxygen/overviews/file.h
index b158cf3bbf735713b1d7035f19f83916e557d2ba..d3a2828a296333071af9ff6377279a6adba6b976 100644 (file)
--- a/docs/doxygen/overviews/file.h
+++ b/docs/doxygen/overviews/file.h
@@ -3,40 +3,39 @@
 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-/*!
+/**
 
- @page overview_file File classes and functions overview
+@page overview_file File Classes and Functions
 
- Classes: #wxFile, #wxDir, #wxTempFile,  #wxTextFile
+@tableofcontents
 
- Functions: see @ref filefunctions_overview.
+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
+between different types of text files (DOS/Unix/Mac).
 
- 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
- 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
+automatically in the destructor which may be quite convenient.
 
- 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
- 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.
 
- wxTempFile is a very small file designed to make replacing the files contents
- 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
+and program source files. It can be also used to work with files with "non
+native" line termination characters and write them as "native" files if needed
+(in fact, the files may be written in any format).
 
- 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
- and program source files. It can be also used to work with files with "non
- native" line termination characters and write them as "native" files if needed
- (in fact, the files may be written in any format).
+wxDir is a helper class for enumerating the files or subdirectories of a
+directory. It may be used to enumerate all files, only files satisfying the
+given template mask or only non-hidden files.
 
- wxDir is a helper class for enumerating the files or subdirectories of a
- directory. It may be used to enumerate all files, only files satisfying the
- given template mask or only non-hidden files.
+@see wxFile, wxDir, wxTempFile,  wxTextFile, @ref group_funcmacro_file
 
 */
-