aboutsummaryrefslogtreecommitdiffstats
path: root/serd
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-08-08 06:11:52 +0000
committerDavid Robillard <d@drobilla.net>2014-08-08 06:11:52 +0000
commit4d63cd1d88ea7b911e56b5f18c3643409b3828c7 (patch)
tree869dab67dde22759b87fed8ac8b10cc4ce795dd5 /serd
parent90a8593b3854707144701dfa1541b3ec74430b12 (diff)
downloadserd-4d63cd1d88ea7b911e56b5f18c3643409b3828c7.tar.gz
serd-4d63cd1d88ea7b911e56b5f18c3643409b3828c7.tar.bz2
serd-4d63cd1d88ea7b911e56b5f18c3643409b3828c7.zip
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/serd/trunk@469 490d8e77-9747-427b-9fa3-0b8f29cee8a0
Diffstat (limited to 'serd')
-rw-r--r--serd/serd.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/serd/serd.h b/serd/serd.h
index 1cd54df8..c06cfc1f 100644
--- a/serd/serd.h
+++ b/serd/serd.h
@@ -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
@@ -691,7 +691,7 @@ serd_reader_new(SerdSyntax syntax,
/**
Set a function to be called when errors occur during reading.
- The @p error_sink will be called with @p handle as its first argument. If
+ The `error_sink` will be called with `handle` as its first argument. If
no error function is set, errors are printed to stderr in GCC style.
*/
SERD_API
@@ -744,10 +744,10 @@ serd_reader_read_file(SerdReader* reader,
/**
Start an incremental read from a file handle.
- Iff @p bulk is true, @p file will be read a page at a time. This is more
+ Iff `bulk` is true, `file` will be read a page at a time. This is more
efficient, but uses a page of memory and means that an entire page of input
must be ready before any callbacks will fire. To react as soon as input
- arrives, set @p bulk to false.
+ arrives, set `bulk` to false.
*/
SERD_API
SerdStatus
@@ -865,7 +865,7 @@ serd_chunk_sink_finish(SerdChunk* stream);
/**
Set a function to be called when errors occur during writing.
- The @p error_sink will be called with @p handle as its first argument. If
+ The `error_sink` will be called with `handle` as its first argument. If
no error function is set, errors are printed to stderr.
*/
SERD_API