Commit Graph

25 Commits

Author SHA1 Message Date
Vadim Zeitlin
0824e36969 Fix premature truncation of brief descriptions in Doxygen comments.
Don't end the brief description at the first period if it's a period which is
part of "i.e." or "e.g.": escape the space following it to prevent Doxygen
from recognizing it as an end of sentence.

See #14866.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73084 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-12-01 00:14:07 +00:00
Vadim Zeitlin
52cd518033 Add @onlyfor tags for Unix-specific wxStandardPaths methods.
Closes #14003.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70644 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:25 +00:00
Vadim Zeitlin
f9afe2fece Document that wxStandardPaths::GetUserConfigDir() doesn't use app info.
Explicitly mention this instead of just relying on the examples to convey it.

Closes #11275.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70543 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-08 02:09:58 +00:00
Vadim Zeitlin
75618d57e4 Emphasize that wxStandardPaths must not be created directly.
wxStandardPaths::Get() must be used instead as the correct object to use might
have a different type.

See #11239.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@68462 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-07-30 17:40:00 +00:00
Vadim Zeitlin
f1b08e84a1 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
2010-09-27 11:51:50 +00:00
Vadim Zeitlin
526954c596 Globally use "wxWindows licence" consistently.
Use "wxWindows licence" and not "wxWidgets licence" (the latter doesn't
exist) and consistently spell "licence" using British spelling.

See #12165.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64940 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-13 13:29:13 +00:00
Stefan Csomor
76dd097ab7 fixing doc for OSX
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64818 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-05 06:39:56 +00:00
Vadim Zeitlin
6da1d056ca Don't use vendor name by default in wxStandardPaths.
The changes in r50025 made the behaviour of wxStandardPaths silently
incompatible with the previous versions under MSW and OS X as it now used the
vendor name in the paths it returned, unlike before. The benefits of doing
this don't justify silently breaking the existing programs so revert this
change and continue to use the application name only by default.

It is, of course, still possible to explicitly ask for the vendor name to be
used with wxStandardPaths::UseAppInfo().

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62360 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-10-10 18:28:28 +00:00
Vadim Zeitlin
306a5d9515 Add a WX_APPNAME_DATA_DIR hack for wxStandardPaths::GetDataDir().
Applications using wxStandardPaths::GetDataDir() to find their files under
Unix can't be ran without being installed as they look for their data files
under $prefix/share/appname. Make it possible to override this location by
setting WX_APPNAME_DATA_DIR environment variable to allow running them without
installation.

Notice that this shouldn't present any security risk unless the application is
SUID (which would be a very bad idea anyhow).

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62337 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-10-08 22:38:03 +00:00
Vadim Zeitlin
4f83b9fc54 Improvements to application info documentation in wxStandardPaths.
Use "appinfo" instead of "appname" in the examples to make it clear that it
may be different from just the application name.

Also make UseAppInfo() documentation more clear.

See #11275.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62336 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-10-08 22:37:53 +00:00
Vadim Zeitlin
9508a056c1 Document wxStandardPaths vendor-related changes.
The change in the values returned by wxStandardPaths functions is important as
it's incompatible with 2.8 if the application defines a vendor name so must be
mentioned in docs/changes.txt.

Also update the documentation of the class itself and mention UseAppInfo() in
the overview.

Closes #11189.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61883 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-09-12 10:41:55 +00:00
Vadim Zeitlin
94aff795d4 Added wxStandardPaths::MSWGetShellDir().
This function allows to get the location of Windows shell special folders not
covered by wxStandardPaths methods (yet), e.g. CSIDL_DESKTOPDIRECTORY.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61662 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-08-14 00:05:56 +00:00
Vadim Zeitlin
4cd15b49b4 allow customizing wxStandardPaths logic for the program directory determination
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61003 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-06-11 16:46:19 +00:00
Vadim Zeitlin
25f49256ac return wxStandardPaths, not wxStandardPathsBase, from wxStandardPathsBase::Get() to allow calling platform-specific methods on it if necessary
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@60935 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-06-06 23:34:05 +00:00
Vadim Zeitlin
d8efd2198f added wxStandardPaths::GetAppDocumentsDir() and use it by default for loading/saving documents in wxDocManager
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58259 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-01-21 14:01:30 +00:00
Francesco Montorsi
382f12e419 many automated ifacecheck fixes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57992 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-01-10 22:42:09 +00:00
Francesco Montorsi
43c48e1e53 automated ifacecheck fixed
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56553 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-10-28 15:36:26 +00:00
Francesco Montorsi
4701dc0983 revised st*.h headers
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56148 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-10-07 16:57:34 +00:00
Vadim Zeitlin
9c498e84bf correct the example/documentation of GetDocumentsDir() return value
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56100 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-10-05 22:56:23 +00:00
Francesco Montorsi
adaaa68635 HUGE commit of ifacecheck-automated fixes to virtualness/constness/staticness of wxWidgets documented functions
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55912 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-09-27 11:21:10 +00:00
Robert Roebling
3f5506cfd3 Another doc patch from Tim
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55343 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-08-29 12:15:59 +00:00
Robert Roebling
4d60a2d5d4 Docs corrections from Tim Stahlhut
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55252 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-08-25 09:12:15 +00:00
Stefan Csomor
0b1b2c71e3 extending docs according #9713
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54787 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-07-26 09:20:44 +00:00
Bryan Petty
12f5e1e78f Commit 3 of 3 for Doxygen path fixes, this one finally removes all 600+ unnecessary uses of @wxheader and @headerfile.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54387 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-06-27 18:00:03 +00:00
Bryan Petty
ae3c17b401 Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-06-27 16:22:58 +00:00