diff options
| author | David Robillard <d@drobilla.net> | 2014-08-08 06:11:52 +0000 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2014-08-08 06:11:52 +0000 |
| commit | 4d63cd1d88ea7b911e56b5f18c3643409b3828c7 (patch) | |
| tree | 869dab67dde22759b87fed8ac8b10cc4ce795dd5 | |
| parent | 90a8593b3854707144701dfa1541b3ec74430b12 (diff) | |
| download | serd-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
| -rw-r--r-- | serd/serd.h | 10 | ||||
| -rw-r--r-- | src/serd_internal.h | 2 | ||||
| -rw-r--r-- | src/uri.c | 6 |
3 files changed, 9 insertions, 9 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 diff --git a/src/serd_internal.h b/src/serd_internal.h index 613493ab..bfdcc19c 100644 --- a/src/serd_internal.h +++ b/src/serd_internal.h @@ -265,7 +265,7 @@ uri_path_at(const SerdURI* uri, size_t i) } } -/** Return true iff @p uri is within the base of @p root */ +/** Return true iff `uri` is within the base of `root` */ static inline bool uri_is_under(const SerdURI* uri, const SerdURI* root) { @@ -317,7 +317,7 @@ remove_dot_segments(const uint8_t* path, size_t len, size_t* up) return begin; } -/// Merge @p base and @p path in-place +/// Merge `base` and `path` in-place static void merge(SerdChunk* base, SerdChunk* path) { @@ -396,7 +396,7 @@ serd_uri_resolve(const SerdURI* r, const SerdURI* base, SerdURI* t) #endif } -/** Write the path of @p uri starting at index @p i */ +/** Write the path of `uri` starting at index `i` */ static size_t write_path_tail(SerdSink sink, void* stream, const SerdURI* uri, size_t i) { @@ -415,7 +415,7 @@ write_path_tail(SerdSink sink, void* stream, const SerdURI* uri, size_t i) return len; } -/** Write the path of @p uri relative to the path of @p base. */ +/** Write the path of `uri` relative to the path of `base`. */ static size_t write_rel_path(SerdSink sink, void* stream, |