diff options
author | David Robillard <d@drobilla.net> | 2014-08-08 15:37:01 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2014-08-08 15:37:01 +0000 |
commit | a91a87e1d7beb455f6d70ece19e62e2e870ed170 (patch) | |
tree | 101328570ae66d9798dd1734a770d0a30ae81538 /lv2/lv2plug.in/ns/ext/state | |
parent | 713944a16b861e1bd2f1da85fb45e9c4cc550498 (diff) | |
download | lv2-a91a87e1d7beb455f6d70ece19e62e2e870ed170.tar.xz |
Use Markdown in doc comments for better source readability.
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/state')
-rw-r--r-- | lv2/lv2plug.in/ns/ext/state/state.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lv2/lv2plug.in/ns/ext/state/state.h b/lv2/lv2plug.in/ns/ext/state/state.h index f701682..95e3dee 100644 --- a/lv2/lv2plug.in/ns/ext/state/state.h +++ b/lv2/lv2plug.in/ns/ext/state/state.h @@ -262,7 +262,7 @@ typedef struct _LV2_State_Interface { } LV2_State_Interface; /** - Feature data for state:mapPath (LV2_STATE__mapPath). + Feature data for state:mapPath (@ref LV2_STATE__mapPath). */ typedef struct { /** @@ -278,12 +278,12 @@ typedef struct { The plugin MUST use this function to map any paths that will be stored in plugin state. The returned value is an abstract path which MAY not - be an actual file system path; @ref absolute_path() MUST be used to map + be an actual file system path; absolute_path() MUST be used to map it to an actual path in order to use the file. Plugins MUST NOT make any assumptions about abstract paths except that they can be mapped back to the absolute path of the "same" file (though - not necessarily the same original path) using @ref absolute_path(). + not necessarily the same original path) using absolute_path(). This function may only be called within the context of LV2_State_Interface methods. The caller is responsible for freeing the |