mouse_set_callbacks doesn't return anything

git-svn-id: svn://svn.cc65.org/cc65/trunk@2938 b7a2c559-68d2-44c3-8de9-860c34a00d81

diff --git a/include/mouse.h b/include/mouse.h
index a27cdf85762211798a752e16cadca3f193dd7bae..decca012d2ba9f19e4fbb1188f55ac7cd79e8341 100644 (file)
--- a/include/mouse.h
+++ b/include/mouse.h
@@ -96,8 +96,12 @@ struct mouse_callbacks {
 
 
 
-unsigned char __fastcall__ mouse_set_callbacks (const struct mouse_callbacks* c);
-/* Sets the callbacks to be used by the driver. */
+void __fastcall__ mouse_set_callbacks (const struct mouse_callbacks* c);
+/* Sets the callbacks to be used by the driver. NOTE: The function will just
+ * remember the pointer, it will not copy the contents of the passed struct.
+ * The latter is done in mouse_install. This means that the struct must be
+ * valid at least until mouse_install is called. Do not use a local variable!
+ */
 
 unsigned char __fastcall__ mouse_load_driver (const char* driver);
 /* Load and install a mouse driver, return an error code. */
@@ -155,8 +159,8 @@ void __fastcall__ mouse_info (struct mouse_info* info);
 /* Return the state of the mouse buttons and the position of the mouse */
 
 unsigned char __fastcall__ mouse_ioctl (unsigned char code, void* data);
-/* Call the driver specific ioctl function. NON PORTABLE! Returns an error 
- * code. 
+/* Call the driver specific ioctl function. NON PORTABLE! Returns an error
+ * code.
  */