Fix typo in wxStandardPathsBase::ResourceCat description and document it.

Document the enum itself and also correct GetLocalizedResourcesDir()
documentation which didn't specify the default value for the category
parameter.

Closes #12523.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65652 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2010-09-27 11:51:50 +00:00
parent b93f4239bb
commit f1b08e84a1
2 changed files with 15 additions and 3 deletions

View File

@@ -28,7 +28,7 @@ class WXDLLIMPEXP_FWD_BASE wxStandardPaths;
class WXDLLIMPEXP_BASE wxStandardPathsBase
{
public:
// possible resources categorires
// possible resources categories
enum ResourceCat
{
// no special category

View File

@@ -54,6 +54,17 @@
class wxStandardPaths
{
public:
/// Possible values for category parameter of GetLocalizedResourcesDir().
enum ResourceCat
{
/// No special category, this is the default.
ResourceCat_None,
/// Message catalog resources category.
ResourceCat_Messages
};
/**
MSW-specific function undoing the effect of IgnoreAppSubDir() calls.
@@ -174,8 +185,9 @@ public:
@since 2.7.0
*/
virtual wxString GetLocalizedResourcesDir(const wxString& lang,
ResourceCat category) const;
virtual wxString
GetLocalizedResourcesDir(const wxString& lang,
ResourceCat category = ResourceCat_None) const;
/**
Return the directory where the loadable modules (plugins) live.