aboutsummaryrefslogtreecommitdiffstats
path: root/libaxl.h
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2020-05-10 21:43:05 +0200
committerMattias Andrée <maandree@kth.se>2020-05-10 21:43:05 +0200
commitba70c37a98850312973b737689d0394a03b34e7d (patch)
tree5e84f54662c8ba09157064482176f0cfca7d7de7 /libaxl.h
parentDocumentation + return -1 screen when not specified (diff)
downloadlibaxl-ba70c37a98850312973b737689d0394a03b34e7d.tar.gz
libaxl-ba70c37a98850312973b737689d0394a03b34e7d.tar.bz2
libaxl-ba70c37a98850312973b737689d0394a03b34e7d.tar.xz
m
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r--libaxl.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/libaxl.h b/libaxl.h
index b9b2c5b..d9b3d26 100644
--- a/libaxl.h
+++ b/libaxl.h
@@ -112,6 +112,9 @@ const struct libaxl_display_info *libaxl_info(LIBAXL_CONNECTION *, int); /* TODO
* ... do something with `depth` or `break` if `i` is of a desired value (index) ...
* }
*
+ * Note, the function does not check if another
+ * element exists
+ *
* @param depth The element before the element to return
* @return The element after `depth`
*/
@@ -134,6 +137,9 @@ libaxl_next_depth(const struct libaxl_depth *depth) /* TODO man */
* ... do something with `screen` or `break` if `i` is of a desired value (index) ...
* }
*
+ * Note, the function does not check if another
+ * element exists
+ *
* @param screen The element before the element to return
* @return The element after `screen`
*/