summaryrefslogtreecommitdiff
path: root/src/dged/location.h
diff options
context:
space:
mode:
authorAlbert Cervin <albert@acervin.com>2024-05-12 22:55:43 +0200
committerAlbert Cervin <albert@acervin.com>2024-05-12 22:55:43 +0200
commit9a4e99b436efefa00277d592ff67798eb491e87a (patch)
tree3603646adf972cd252772b7b2832ca72fcdcaa4b /src/dged/location.h
parent1e7e71d151bac48f150b4edb4bfa3f1ac4e80f44 (diff)
downloaddged-9a4e99b436efefa00277d592ff67798eb491e87a.tar.gz
dged-9a4e99b436efefa00277d592ff67798eb491e87a.tar.xz
dged-9a4e99b436efefa00277d592ff67798eb491e87a.zip
Improve API docs and configure system
There is now a super minimalistic configure script that automatically detects the event system (epoll/kqueue) and generates a config.h and a config.mk.
Diffstat (limited to 'src/dged/location.h')
-rw-r--r--src/dged/location.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/dged/location.h b/src/dged/location.h
index d11dd94..4404595 100644
--- a/src/dged/location.h
+++ b/src/dged/location.h
@@ -21,7 +21,7 @@ struct location {
* @param [in] location The location to test.
* @param [in] l1 The first location.
* @param [in] l2 The other location.
- * @returns True if @ref location is between @ref l1 and @ref l2.
+ * @returns True if @p location is between @p l1 and @p l2.
*/
bool location_is_between(struct location location, struct location l1,
struct location l2);
@@ -32,8 +32,8 @@ bool location_is_between(struct location location, struct location l1,
* @param [in] l1 The first location.
* @param [in] l2 The second location.
*
- * @returns -1 if @ref l1 is before @ref l2, 0 if @ref l1 is equal to @ref l2
- * and +1 if @ref l1 is after @ref l2.
+ * @returns -1 if @p l1 is before @p l2, 0 if @p l1 is equal to @p l2
+ * and +1 if @p l1 is after @p l2.
*/
int location_compare(struct location l1, struct location l2);
@@ -72,7 +72,7 @@ bool region_has_size(struct region region);
*
* @param [in] region The region to test.
* @param [in] location The location to test.
- * @returns True if @ref location is inside @ref region.
+ * @returns True if @p location is inside @p region.
*/
bool region_is_inside(struct region region, struct location location);