aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-08-08 14:46:31 +0000
committerDavid Robillard <d@drobilla.net>2014-08-08 14:46:31 +0000
commit31bf2e814776e58a78fd8302304eaf8943280c36 (patch)
treed7bfb1073973adae54689500570c6b69f5be6f09 /src
parentbf7cd4d3c1feea03c61e38c3fffdd60a07f6004e (diff)
downloadserd-31bf2e814776e58a78fd8302304eaf8943280c36.tar.gz
serd-31bf2e814776e58a78fd8302304eaf8943280c36.tar.bz2
serd-31bf2e814776e58a78fd8302304eaf8943280c36.zip
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/serd/trunk@471 490d8e77-9747-427b-9fa3-0b8f29cee8a0
Diffstat (limited to 'src')
-rw-r--r--src/env.c2
-rw-r--r--src/reader.c4
-rw-r--r--src/serd_internal.h2
-rw-r--r--src/uri.c2
4 files changed, 5 insertions, 5 deletions
diff --git a/src/env.c b/src/env.c
index c368d7ce..514e487d 100644
--- a/src/env.c
+++ b/src/env.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
diff --git a/src/reader.c b/src/reader.c
index d96a2d2f..c911f158 100644
--- a/src/reader.c
+++ b/src/reader.c
@@ -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
diff --git a/src/serd_internal.h b/src/serd_internal.h
index bfdcc19c..d96d4969 100644
--- a/src/serd_internal.h
+++ b/src/serd_internal.h
@@ -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)
{
diff --git a/src/uri.c b/src/uri.c
index 467b54c1..4aff03fa 100644
--- a/src/uri.c
+++ b/src/uri.c
@@ -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