diff options
author | David Robillard <d@drobilla.net> | 2014-07-31 20:39:26 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2014-07-31 20:39:26 +0000 |
commit | 1c67d8123580b5cf70b5530277ad8320e97174cd (patch) | |
tree | 7b2382e550b35c6d87362f8995198f640fd5fdad /lv2/lv2plug.in/ns/ext/urid/urid.h | |
parent | 64e25ef4f27e9e82402ba1a361e8c443eefc93db (diff) | |
download | lv2-1c67d8123580b5cf70b5530277ad8320e97174cd.tar.xz |
Use Doxygen Markdown support for more human-readable doc comments.
Minor improvements to UI documentation.
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/urid/urid.h')
-rw-r--r-- | lv2/lv2plug.in/ns/ext/urid/urid.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lv2/lv2plug.in/ns/ext/urid/urid.h b/lv2/lv2plug.in/ns/ext/urid/urid.h index c317f7f..5a308c5 100644 --- a/lv2/lv2plug.in/ns/ext/urid/urid.h +++ b/lv2/lv2plug.in/ns/ext/urid/urid.h @@ -106,11 +106,11 @@ typedef struct _LV2_URID_Unmap { /** Get the URI for a previously mapped numeric ID. - Returns NULL if @p urid is not yet mapped. Otherwise, the corresponding + Returns NULL if `urid` is not yet mapped. Otherwise, the corresponding URI is returned in a canonical form. This MAY not be the exact same string that was originally passed to LV2_URID_Map::map(), but it MUST be an identical URI according to the URI syntax specification (RFC3986). A - non-NULL return for a given @p urid will always be the same for the life + non-NULL return for a given `urid` will always be the same for the life of the plugin. Plugins that intend to perform string comparison on unmapped URIs SHOULD first canonicalise URI strings with a call to map_uri() followed by a call to unmap_uri(). |