aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-08-08 06:12:09 +0000
committerDavid Robillard <d@drobilla.net>2014-08-08 06:12:09 +0000
commitb76b671058c363adc196ff165f730f93f4cb841d (patch)
treebe0e1bd35d455e303f48c483430d65ea1b3f58f1 /src
parent28aef6cc02fb1e0dc89ac5ebbb7782e78fdf2eb1 (diff)
downloadjalv-b76b671058c363adc196ff165f730f93f4cb841d.tar.gz
jalv-b76b671058c363adc196ff165f730f93f4cb841d.tar.bz2
jalv-b76b671058c363adc196ff165f730f93f4cb841d.zip
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/lad/trunk/jalv@5428 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'src')
-rw-r--r--src/lv2_evbuf.h26
1 files changed, 13 insertions, 13 deletions
diff --git a/src/lv2_evbuf.h b/src/lv2_evbuf.h
index fdb7766..dfd53df 100644
--- a/src/lv2_evbuf.h
+++ b/src/lv2_evbuf.h
@@ -1,5 +1,5 @@
/*
- Copyright 2008-2012 David Robillard <http://drobilla.net>
+ Copyright 2008-2014 David Robillard <http://drobilla.net>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
@@ -100,7 +100,7 @@ void*
lv2_evbuf_get_buffer(LV2_Evbuf* evbuf);
/**
- Return an iterator to the start of @p buf.
+ Return an iterator to the start of `buf`.
*/
LV2_Evbuf_Iterator
lv2_evbuf_begin(LV2_Evbuf* evbuf);
@@ -112,26 +112,26 @@ LV2_Evbuf_Iterator
lv2_evbuf_end(LV2_Evbuf* evbuf);
/**
- Check if @p iter is valid.
- @return True if @p iter is valid, otherwise false (past end of buffer)
+ Check if `iter` is valid.
+ @return True if `iter` is valid, otherwise false (past end of buffer)
*/
bool
lv2_evbuf_is_valid(LV2_Evbuf_Iterator iter);
/**
- Advance @p iter forward one event.
- @p iter must be valid.
- @return True if @p iter is valid, otherwise false (reached end of buffer)
+ Advance `iter` forward one event.
+ `iter` must be valid.
+ @return True if `iter` is valid, otherwise false (reached end of buffer)
*/
LV2_Evbuf_Iterator
lv2_evbuf_next(LV2_Evbuf_Iterator iter);
/**
Dereference an event iterator (i.e. get the event currently pointed to).
- @p iter must be valid.
- @p type Set to the type of the event.
- @p size Set to the size of the event.
- @p data Set to the contents of the event.
+ `iter` must be valid.
+ `type` Set to the type of the event.
+ `size` Set to the size of the event.
+ `data` Set to the contents of the event.
@return True on success.
*/
bool
@@ -143,8 +143,8 @@ lv2_evbuf_get(LV2_Evbuf_Iterator iter,
uint8_t** data);
/**
- Write an event at @p iter.
- The event (if any) pointed to by @p iter will be overwritten, and @p iter
+ Write an event at `iter`.
+ The event (if any) pointed to by `iter` will be overwritten, and `iter`
incremented to point to the following event (i.e. several calls to this
function can be done in sequence without twiddling iter in-between).
@return True if event was written, otherwise false (buffer is full).