diff options
author | David Robillard <d@drobilla.net> | 2009-11-27 17:40:15 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2009-11-27 17:40:15 +0000 |
commit | aefb54c61703a6c0efe785945e1dd1db767de4f5 (patch) | |
tree | 6b549de3d5ed51d8b2e07c9bba820963adc15868 /raul/Path.hpp | |
parent | 74a9b13ad87f381b05b007d38912446506a20168 (diff) | |
download | raul-aefb54c61703a6c0efe785945e1dd1db767de4f5.tar.gz raul-aefb54c61703a6c0efe785945e1dd1db767de4f5.tar.bz2 raul-aefb54c61703a6c0efe785945e1dd1db767de4f5.zip |
Documentation updates.
git-svn-id: http://svn.drobilla.net/lad/trunk/raul@2286 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'raul/Path.hpp')
-rw-r--r-- | raul/Path.hpp | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/raul/Path.hpp b/raul/Path.hpp index b549f88..5119530 100644 --- a/raul/Path.hpp +++ b/raul/Path.hpp @@ -30,17 +30,17 @@ namespace Raul { -/** Simple wrapper around standard string with useful path-specific methods. +/** A URI which is a path (for example a filesystem or OSC path). * - * This enforces that a Path is a valid OSC path (though it is used for - * GraphObject paths, which aren't directly OSC paths but a portion of one). + * A Path always has the special URI scheme "path:". + * + * This enforces that a Path is a valid path, where each fragment is a valid + * Symbol, separated by exactly one slash (/). * * A path is divided by slashes (/). The first character MUST be a slash, and * the last character MUST NOT be a slash (except in the special case of the - * root path "/", which is the only valid single-character path). - * - * Valid characters are the 95 printable ASCII characters (32-126), excluding: - * space # * , ? [ ] { } + * root path "/", which is the only valid single-character path). The path: + * scheme is added automatically (since a Patch is actually a URI). * * \ingroup raul */ |