X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/58fa97d15f22d38bbd1aecaebfe804f8c7129f9d..e18e78a7cc106a75e5228c51edd982436682633d:/docs/doxygen/overviews/filesystem.h diff --git a/docs/doxygen/overviews/filesystem.h b/docs/doxygen/overviews/filesystem.h index 621eaaf39f..f48a446fce 100644 --- a/docs/doxygen/overviews/filesystem.h +++ b/docs/doxygen/overviews/filesystem.h @@ -6,9 +6,9 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// -/*! +/** - @page overview_fs wxFileSystem overview + @page overview_fs wxFileSystem Overview The wxHTML library uses a @b virtual file systems mechanism similar to the one used in Midnight Commander, Dos Navigator, @@ -30,13 +30,13 @@ Three classes are used in order to provide virtual file systems mechanism: - @li The #wxFSFile class provides information + @li The wxFSFile class provides information about opened file (name, input stream, mime type and anchor). - @li The #wxFileSystem class is the interface. + @li The wxFileSystem class is the interface. Its main methods are ChangePathTo() and OpenFile(). This class is most often used by the end user. - @li The #wxFileSystemHandler is the core - of virtual file systems mechanism. You can derive your own handler and pass + @li The wxFileSystemHandler is the core + of virtual file systems mechanism. You can derive your own handler and pass it to the VFS mechanism. You can derive your own handler and pass it to wxFileSystem's AddHandler() method. In the new handler you only need to override the OpenFile() and CanOpen() methods.