From: mrdudz <mrdudz@users.noreply.github.com>
Date: Sun, 6 Aug 2017 18:15:35 +0000 (+0200)
Subject: added documentation for the kbrepeat... functions
X-Git-Tag: V2.17~104^2~4
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=dafe3c1e3cc3316ff187e4adfd756097865d2ae4;p=cc65

added documentation for the kbrepeat... functions
---

diff --git a/doc/funcref.sgml b/doc/funcref.sgml
index a2ccf6c73..d7c477958 100644
--- a/doc/funcref.sgml
+++ b/doc/funcref.sgml
@@ -179,6 +179,9 @@ function.
 <!-- <item><ref id="cbm_save" name="cbm_save"> -->
 <!-- <item><ref id="cbm_write" name="cbm_write"> -->
 <!-- <item><ref id="get_tv" name="get_tv"> -->
+<item><ref id="kbrepeat" name="kbrepeat">
+<item><ref id="kbrepeatdelay" name="kbrepeatdelay">
+<item><ref id="kbrepeatrate" name="kbrepeatrate">
 </itemize>
 
 (incomplete)
@@ -2063,6 +2066,70 @@ to get off the serial bus so it can be used for other purposes.
 </descrip>
 </quote>
 
+<sect1>kbrepeat<label id="kbrepeat"><p>
+
+<quote>
+<descrip>
+<tag/Function/Set keyboard repeat mode
+<tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
+<tag/Declaration/<tt/unsigned char kbrepeat (unsigned char);/
+<tag/Description/This function changes what keys will have automatic repeat when
+being hold down for a certain time. Possible values are KBDREPEAT_CURSOR (repeat
+only cursor-related keys), KBDREPEAT_NONE (no repeat for any keys) and 
+KBDREPEAT_ALL (repeat all keys).
+The old mode is returned so it can be restored later.
+<tag/Notes/<itemize>
+<item>
+</itemize>
+<tag/Availability/cc65
+<tag/See also/
+<ref id="kbrepeatdelay" name="kbrepeatdelay">
+<ref id="kbrepeatrate" name="kbrepeatrate">
+<tag/Example/None.
+</descrip>
+</quote>
+
+<sect1>kbrepeatdelay<label id="kbrepeatdelay"><p>
+
+<quote>
+<descrip>
+<tag/Function/Set keyboard repeat delay
+<tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
+<tag/Declaration/<tt/unsigned char kbrepeatdelay (unsigned char);/
+<tag/Description/This function changes the delay until a keypress is being
+repeated automatically.
+The old value is returned so it can be restored later.
+<tag/Notes/<itemize>
+<item>
+</itemize>
+<tag/Availability/cc65
+<tag/See also/
+<ref id="kbrepeat" name="kbrepeat">
+<ref id="kbrepeatrate" name="kbrepeatrate">
+<tag/Example/None.
+</descrip>
+</quote>
+
+<sect1>kbrepeatrate<label id="kbrepeatrate"><p>
+
+<quote>
+<descrip>
+<tag/Function/Set keyboard repeat rate
+<tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
+<tag/Declaration/<tt/unsigned char kbrepeatrate (unsigned char);/
+<tag/Description/This function changes the keyboard repeat rate (the time between
+repeated keypresses).
+The old value is returned so it can be restored later.
+<tag/Notes/<itemize>
+<item>
+</itemize>
+<tag/Availability/cc65
+<tag/See also/
+<ref id="kbrepeat" name="kbrepeat">
+<ref id="kbrepeatdelay" name="kbrepeatdelay">
+<tag/Example/None.
+</descrip>
+</quote>
 
 <sect1>cclear<label id="cclear"><p>