Browse Source

Use Markdown in doc comments for better source readability.

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

2
src/env.c

@ -167,7 +167,7 @@ is_nameChar(const uint8_t c) @@ -167,7 +167,7 @@ is_nameChar(const uint8_t c)
}
/**
Return true iff @c buf is a valid prefixed name suffix.
Return true iff `buf` is a valid prefixed name suffix.
TODO: This is more strict than it should be.
*/
static inline bool

4
src/reader.c

@ -82,8 +82,8 @@ struct SerdReaderImpl { @@ -82,8 +82,8 @@ struct SerdReaderImpl {
uint8_t* file_buf;
int32_t read_head; ///< Offset into read_buf
uint8_t read_byte; ///< 1-byte 'buffer' used when not paging
bool from_file; ///< True iff reading from @ref fd
bool paging; ///< True iff reading a page at a time
bool from_file; ///< True iff reading from `fd`
bool paging; ///< True iff reading a page at a time
bool eof;
bool seen_genid;
#ifdef SERD_STACK_CHECK

2
src/serd_internal.h

@ -195,7 +195,7 @@ serd_bulk_sink_write(const void* buf, size_t len, SerdBulkSink* bsink) @@ -195,7 +195,7 @@ serd_bulk_sink_write(const void* buf, size_t len, SerdBulkSink* bsink)
/* Character utilities */
/** Return true if @a c lies within [min...max] (inclusive) */
/** Return true if `c` lies within [`min`...`max`] (inclusive) */
static inline bool
in_range(const uint8_t c, const uint8_t min, const uint8_t max)
{

2
src/uri.c

@ -252,7 +252,7 @@ end: @@ -252,7 +252,7 @@ end:
}
/**
Remove leading dot components from @c path.
Remove leading dot components from `path`.
See http://tools.ietf.org/html/rfc3986#section-5.2.3
@param up Set to the number of up-references (e.g. "../") trimmed
@return A pointer to the new start of @path

Loading…
Cancel
Save