solemnwarning/wxwidgets
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Improve wxFileSystem::AddHandler() documentation

Browse source 
The note in the method description incorrectly stated that
"...the handlers are deleted in wxFileSystem's destructor so
that you don't have to care about it." However, unless a
handler is removed by calling wxFileSystem::RemoveHandler()
(or undocumented wxFileSystem::CleanUpHandlers()), it is deleted
only when wxWidgets shuts down in wxFileSystemModule::OnExit().

Update the method documentation that it is correct (and similar to
that of wxImage::AddHandler()).

Closes #23789.
This commit is contained in:
PB 2023-08-21 18:12:44 +02:00 • committed by Vadim Zeitlin
parent d282cc9657
commit af453674b6
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
interface/wx/filesys.h
View file

@ -44,19 +44,19 @@ public:
wxFileSystem();
/**
This static function adds new handler into the list of handlers
(see wxFileSystemHandler) which provide access to virtual FS.
This static function adds a new handler into the list of handlers
which provide access to virtual FS.
Note that if two handlers for the same protocol are added, the last
@a handler must be a heap-allocated object which will be deleted
if it is removed by RemoveHandler() or at program shutdown.
Typical example of use:
@code
wxFileSystem::AddHandler(new wxZipFSHandler);
@endcode
@note If two handlers for the same protocol are added, the last
added one takes precedence.
@note You can call:
@code
wxFileSystem::AddHandler(new My_FS_Handler);
@endcode
This is because (a) AddHandler is a static method, and (b) the
handlers are deleted in wxFileSystem's destructor so that you
don't have to care about it.
*/
static void AddHandler(wxFileSystemHandler* handler);