aboutsummaryrefslogtreecommitdiff
path: root/bterm.h
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2019-05-28 22:29:22 -0700
committerBruce Hill <bruce@bruce-hill.com>2019-05-28 22:29:22 -0700
commit53ad7396162bb1791361f3e29d5a62a62fee401d (patch)
tree62f5c35255d6e4e15fc8458cf4ae6dd77b03c442 /bterm.h
parent331a004dffa02b1669b953aa3364e490edd722be (diff)
Added documentation for all functions, simplified sorting a little
Diffstat (limited to 'bterm.h')
-rw-r--r--bterm.h5
1 files changed, 2 insertions, 3 deletions
diff --git a/bterm.h b/bterm.h
index faf6efa..4236a79 100644
--- a/bterm.h
+++ b/bterm.h
@@ -120,9 +120,8 @@ static inline int nextchar(int fd, int timeout)
return -1;
}
-/**
+/*
* Get one key of input from the given file. Returns -1 on failure.
- *
* If mouse_x or mouse_y are non-null and a mouse event occurs, they will be
* set to the position of the mouse (0-indexed).
*/
@@ -228,7 +227,7 @@ int bgetkey(FILE *in, int *mouse_x, int *mouse_y, int timeout)
return -1;
}
-/**
+/*
* Return the name of a key, if one exists and is different from the key itself
* (i.e. bkeyname('c') == NULL, bkeyname(' ') == "Space")
*/