minor corrections: document typeDefault, remove text copied from the header (closes...

[wxWidgets.git] / interface / wx / stdpaths.h

diff --git a/interface/wx/stdpaths.h b/interface/wx/stdpaths.h
index b72c98bd520ef522945d5f509ba587cba5916620..af4dac1d2900045c87b09d15b47db1095f8f0e55 100644 (file)
--- a/interface/wx/stdpaths.h
+++ b/interface/wx/stdpaths.h
@@ -53,6 +53,23 @@ public:
     */
     static wxStandardPathsBase& Get();
 
+    /**
+        Return the directory for the document files used by this application.
+
+        If the application-specific directory doesn't exist, this function
+        returns GetDocumentsDir().
+
+        Example return values:
+        - Unix: @c ~/appname
+        - Windows: @c "C:\Documents and Settings\username\My Documents\appname"
+        - Mac: @c ~/Documents/appname
+
+        @since 2.9.0
+
+        @see GetAppDocumentsDir()
+     */
+    virtual wxString GetAppDocumentsDir() const;
+
     /**
         Return the directory containing the system config files.
         Example return values:
@@ -78,12 +95,15 @@ public:
 
     /**
         Return the directory containing the current user's documents.
+
         Example return values:
         - Unix: @c ~ (the home directory)
         - Windows: @c "C:\Documents and Settings\username\My Documents"
         - Mac: @c ~/Documents
 
         @since 2.7.0
+
+        @see GetAppDocumentsDir()
     */
     virtual wxString GetDocumentsDir() const;