removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -71,7 +71,6 @@ public:
|
||||
|
||||
/**
|
||||
Destructor frees the associated resources.
|
||||
|
||||
Note that it is not virtual, this class is not meant to be used polymorphically
|
||||
*/
|
||||
~wxSingleInstanceChecker();
|
||||
@@ -83,19 +82,18 @@ public:
|
||||
had been used is an error.
|
||||
|
||||
@param name
|
||||
must be given and be as unique as possible. It is used as the
|
||||
mutex name under Win32 and the lock file name under Unix.
|
||||
GetAppName() and wxGetUserId()
|
||||
are commonly used to construct this parameter.
|
||||
|
||||
must be given and be as unique as possible. It is used as the
|
||||
mutex name under Win32 and the lock file name under Unix.
|
||||
GetAppName() and wxGetUserId()
|
||||
are commonly used to construct this parameter.
|
||||
@param path
|
||||
is optional and is ignored under Win32 and used as the directory to
|
||||
create the lock file in under Unix (default is
|
||||
wxGetHomeDir())
|
||||
is optional and is ignored under Win32 and used as the directory to
|
||||
create the lock file in under Unix (default is
|
||||
wxGetHomeDir())
|
||||
|
||||
@returns Returns @false if initialization failed, it doesn't mean that
|
||||
another instance is running - use IsAnotherRunning()
|
||||
to check for it.
|
||||
another instance is running - use IsAnotherRunning()
|
||||
to check for it.
|
||||
*/
|
||||
bool Create(const wxString& name,
|
||||
const wxString& path = wxEmptyString);
|
||||
|
Reference in New Issue
Block a user