diff options
author | David Robillard <d@drobilla.net> | 2014-08-08 06:12:09 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2014-08-08 06:12:09 +0000 |
commit | 6773fba30029b5050a099ab0dd91ec15352a9f2b (patch) | |
tree | 95dadcfc5db25b56831160e8fb29b57cc0579c63 /raul/URI.hpp | |
parent | be40ec20bee088486e823d9824a72a8dfcb2c58e (diff) | |
download | raul-6773fba30029b5050a099ab0dd91ec15352a9f2b.tar.gz raul-6773fba30029b5050a099ab0dd91ec15352a9f2b.tar.bz2 raul-6773fba30029b5050a099ab0dd91ec15352a9f2b.zip |
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/lad/trunk/raul@5428 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'raul/URI.hpp')
-rw-r--r-- | raul/URI.hpp | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/raul/URI.hpp b/raul/URI.hpp index b2ccad7..c84ef2b 100644 --- a/raul/URI.hpp +++ b/raul/URI.hpp @@ -37,7 +37,7 @@ public: /** Construct a URI from a C++ string. * - * This will throw an exception if @p uri is invalid. To avoid this, use + * This will throw an exception if `uri` is invalid. To avoid this, use * is_valid() first to check. */ explicit URI(const std::basic_string<char>& uri) @@ -50,7 +50,7 @@ public: /** Construct a URI from a C string. * - * This will throw an exception if @p uri is invalid. To avoid this, use + * This will throw an exception if `uri` is invalid. To avoid this, use * is_valid() first to check. */ explicit URI(const char* uri) @@ -70,21 +70,21 @@ public: : std::basic_string<char>(uri) {} - /** Return true iff @p c is a valid URI start character. */ + /** Return true iff `c` is a valid URI start character. */ static inline bool is_valid_start_char(char c) { return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'); } - /** Return true iff @p c is a valid URI scheme character. */ + /** Return true iff `c` is a valid URI scheme character. */ static inline bool is_valid_scheme_char(char c) { // S3.1: scheme ::= ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) return is_valid_start_char(c) || (c >= '0' && c <= '9') || c == '+' || c == '-' || c == '.'; } - /** Return true iff @p str is a valid URI. + /** Return true iff `str` is a valid URI. * - * Currently this only checks that @p starts with a valid URI scheme. + * Currently this only checks that `starts` with a valid URI scheme. */ static inline bool is_valid(const std::basic_string<char>& str) { if (!is_valid_start_char(str[0])) { |