Browse Source

Use Markdown in doc comments for better source readability.

git-svn-id: http://svn.drobilla.net/serd/trunk@469 490d8e77-9747-427b-9fa3-0b8f29cee8a0
zrythm_meson
David Robillard 8 years ago
parent
commit
4d63cd1d88
  1. 10
      serd/serd.h
  2. 2
      src/serd_internal.h
  3. 6
      src/uri.c

10
serd/serd.h

@ -1,5 +1,5 @@ @@ -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, @@ -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, @@ -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); @@ -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

2
src/serd_internal.h

@ -265,7 +265,7 @@ uri_path_at(const SerdURI* uri, size_t i) @@ -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)
{

6
src/uri.c

@ -317,7 +317,7 @@ remove_dot_segments(const uint8_t* path, size_t len, size_t* up) @@ -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) @@ -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) @@ -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,

Loading…
Cancel
Save