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/Symbol.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/Symbol.hpp')
| -rw-r--r-- | raul/Symbol.hpp | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/raul/Symbol.hpp b/raul/Symbol.hpp index 6658cf3..8aa82c1 100644 --- a/raul/Symbol.hpp +++ b/raul/Symbol.hpp @@ -27,10 +27,15 @@ namespace Raul { -/** A restricted string (C identifier, which is a component of a path). +/** A restricted string (C identifier, which is a component of a Path). + * + * A Symbol is a very restricted string suitable for use as an identifier. + * It is a valid LV2 symbol, URI fragment, filename, OSC path fragment, + * and identifier for most programming languages (including C). + * + * Valid characters are _, a-z, A-Z, 0-9, except the first character which + * must not be 0-9. * - * A Symbol is an lv2-compliant symbol, which is also valid as a component of - * a URI, filesystem or OSC path, programming language identifier, etc. * \ingroup raul */ class Symbol : public std::basic_string<char> { |