Update doxgen config and some comments.

[simgear.git] / simgear / misc / sg_path.hxx

diff --git a/simgear/misc/sg_path.hxx b/simgear/misc/sg_path.hxx
index 97587fe687d1169ed293d7684d4a2c3ab4b4e445..cce05ebc36a8fd9e9d7499a64974f91583683b67 100644 (file)
--- a/simgear/misc/sg_path.hxx
+++ b/simgear/misc/sg_path.hxx
@@ -57,10 +57,10 @@ public:
       bool read : 1;
       bool write : 1;
     };
-    typedef Permissions (*PermissonChecker)(const SGPath&);
+    typedef Permissions (*PermissionChecker)(const SGPath&);
 
     /** Default constructor */
-    explicit SGPath(PermissonChecker validator = NULL);
+    explicit SGPath(PermissionChecker validator = NULL);
 
     /** Copy contructor */
     SGPath(const SGPath& p);
@@ -71,7 +71,7 @@ public:
      * Construct a path based on the starting path provided.
      * @param p initial path
      */
-    SGPath( const std::string& p, PermissonChecker validator = NULL );
+    SGPath( const std::string& p, PermissionChecker validator = NULL );
 
     /**
      * Construct a path based on the starting path provided and a relative subpath
@@ -80,7 +80,7 @@ public:
      */
     SGPath( const SGPath& p,
             const std::string& r,
-            PermissonChecker validator = NULL );
+            PermissionChecker validator = NULL );
 
     /** Destructor */
     ~SGPath();
@@ -95,8 +95,8 @@ public:
     bool operator==(const SGPath& other) const;
     bool operator!=(const SGPath& other) const;
 
-    void setPermissonChecker(PermissonChecker validator);
-    PermissonChecker getPermissonChecker() const;
+    void setPermissionChecker(PermissionChecker validator);
+    PermissionChecker getPermissionChecker() const;
 
     /**
      * Set if file information (exists, type, mod-time) is cached or
@@ -257,6 +257,18 @@ public:
      */
     bool rename(const SGPath& newName);
 
+    enum StandardLocation
+    {
+      HOME,
+      DESKTOP,
+      DOWNLOADS,
+      DOCUMENTS,
+      PICTURES
+    };
+
+    static SGPath standardLocation( StandardLocation type,
+                                    const SGPath& def = SGPath() );
+
     /**
      * Get a path stored in the environment variable with the given \a name.
      *
@@ -269,12 +281,17 @@ public:
     /**
      * Get path to user's home directory
      */
-    static SGPath home();
+    static SGPath home(const SGPath& def = SGPath());
 
     /**
      * Get path to the user's desktop directory
      */
-    static SGPath desktop();
+    static SGPath desktop(const SGPath& def = SGPath());
+
+       /**
+     * Get path to the user's documents directory
+     */
+    static SGPath documents(const SGPath& def = SGPath());
 
 private:
 
@@ -284,7 +301,7 @@ private:
     void checkAccess() const;
 
     std::string path;
-    PermissonChecker _permisson_checker;
+    PermissionChecker _permission_checker;
 
     mutable bool _cached : 1;
     mutable bool _rwCached : 1;