aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-08-08 14:46:53 +0000
committerDavid Robillard <d@drobilla.net>2014-08-08 14:46:53 +0000
commitabf0666c776298c873f3ff32e4b3874f0b9db357 (patch)
tree7f7ebe931a9259b69ca60699c8e1050b022cd451
parentb76b671058c363adc196ff165f730f93f4cb841d (diff)
downloadjalv-abf0666c776298c873f3ff32e4b3874f0b9db357.tar.gz
jalv-abf0666c776298c873f3ff32e4b3874f0b9db357.tar.bz2
jalv-abf0666c776298c873f3ff32e4b3874f0b9db357.zip
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/lad/trunk/jalv@5429 a436a847-0d15-0410-975c-d299462d15a1
-rw-r--r--src/lv2_evbuf.h4
-rw-r--r--src/symap.c10
-rw-r--r--src/zix/sem.h4
-rw-r--r--src/zix/thread.h8
4 files changed, 13 insertions, 13 deletions
diff --git a/src/lv2_evbuf.h b/src/lv2_evbuf.h
index dfd53df..42951f0 100644
--- a/src/lv2_evbuf.h
+++ b/src/lv2_evbuf.h
@@ -100,13 +100,13 @@ void*
lv2_evbuf_get_buffer(LV2_Evbuf* evbuf);
/**
- Return an iterator to the start of `buf`.
+ Return an iterator to the start of `evbuf`.
*/
LV2_Evbuf_Iterator
lv2_evbuf_begin(LV2_Evbuf* evbuf);
/**
- Return an iterator to the end of @a buf.
+ Return an iterator to the end of `evbuf`.
*/
LV2_Evbuf_Iterator
lv2_evbuf_end(LV2_Evbuf* evbuf);
diff --git a/src/symap.c b/src/symap.c
index a218c81..40c8980 100644
--- a/src/symap.c
+++ b/src/symap.c
@@ -1,5 +1,5 @@
/*
- Copyright 2011-2012 David Robillard <http://drobilla.net>
+ Copyright 2011-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
@@ -45,12 +45,12 @@ struct SymapImpl {
char** symbols;
/**
- Array of IDs, sorted by corresponding string in @ref symbols.
+ Array of IDs, sorted by corresponding string in `symbols`.
*/
uint32_t* index;
/**
- Number of symbols (number of items in @ref symbols and @ref index).
+ Number of symbols (number of items in `symbols` and `index`).
*/
uint32_t size;
};
@@ -87,8 +87,8 @@ symap_strdup(const char* str)
}
/**
- Return the index into map->index (not the ID) corresponding to @c sym,
- or the index where a new entry for @c sym should be inserted.
+ Return the index into map->index (not the ID) corresponding to `sym`,
+ or the index where a new entry for `sym` should be inserted.
*/
static uint32_t
symap_search(const Symap* map, const char* sym, bool* exact)
diff --git a/src/zix/sem.h b/src/zix/sem.h
index 72c7d8d..6a6dc8e 100644
--- a/src/zix/sem.h
+++ b/src/zix/sem.h
@@ -59,13 +59,13 @@ extern "C" {
typedef struct ZixSemImpl ZixSem;
/**
- Create and initialize @c sem to @c initial.
+ Create and initialize `sem` to `initial`.
*/
static inline ZixStatus
zix_sem_init(ZixSem* sem, unsigned initial);
/**
- Destroy @c sem.
+ Destroy `sem`.
*/
static inline void
zix_sem_destroy(ZixSem* sem);
diff --git a/src/zix/thread.h b/src/zix/thread.h
index ff5a727..b007efa 100644
--- a/src/zix/thread.h
+++ b/src/zix/thread.h
@@ -1,5 +1,5 @@
/*
- Copyright 2012 David Robillard <http://drobilla.net>
+ Copyright 2012-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
@@ -46,9 +46,9 @@ typedef pthread_t ZixThread;
#endif
/**
- Initialize @c thread to a new thread.
+ Initialize `thread` to a new thread.
- The thread will immediately be launched, calling @c function with @c arg
+ The thread will immediately be launched, calling `function` with `arg`
as the only parameter.
*/
static inline ZixStatus
@@ -58,7 +58,7 @@ zix_thread_create(ZixThread* thread,
void* arg);
/**
- Join @c thread (block until @c thread exits).
+ Join `thread` (block until `thread` exits).
*/
static inline ZixStatus
zix_thread_join(ZixThread thread, void** retval);