From f0e0c9007c30fefe14920ac055eaf9e1f7a8a19e Mon Sep 17 00:00:00 2001 From: izydorst Date: Mon, 18 Aug 2003 00:05:49 +0000 Subject: [PATCH] documentation updates, EnterDesktop() is equal to exit(0) git-svn-id: svn://svn.cc65.org/cc65/trunk@2361 b7a2c559-68d2-44c3-8de9-860c34a00d81 --- doc/geos.sgml | 50 ++++++++++++++++++------------- libsrc/geos/system/enterdesktop.s | 5 +++- 2 files changed, 33 insertions(+), 22 deletions(-) diff --git a/doc/geos.sgml b/doc/geos.sgml index 67ee5ccf0..1d4c2f30f 100644 --- a/doc/geos.sgml +++ b/doc/geos.sgml @@ -549,6 +549,9 @@ after a click. Otherwise the user must choose an icon.

Note: use it if you really need (or if you will use it in many places) as it adds quite amount of code to your program. +

+Note: the formatted text Mouse, Sprites and Cursors

@@ -796,7 +799,7 @@ struct tr_se myTrSe;

In this example -NOTE that you Low-level disk IO

@@ -1071,12 +1074,14 @@ This function will load or save at most However some of them have slighty different calling convention (order of arguments to be specific), so please check their syntax here before direct replacing. - -Please note that the memory described as +Please note that the memory areas described here as CopyString

@@ -1146,7 +1151,8 @@ This is done with These functions are interface to REU - Ram Expansion Unit. I think that they are self-explanatory. -You can check for REU presence by taking value of Processes and Multitasking

@@ -1208,18 +1214,18 @@ It means that if you call Sleep

-This function is multitasking sleep - the program is halted, but it doesn't block other functions. -The only argument here is the number of jiffies to wait until app will wake up. -

-You can force to sleep not only the main application routine, but also processes-tasks. Be warned -that the maximum number of sleeping functions is 20. If it would be larger it will overwrite -parameters of already sleeping functions in GEOS kernal data space, leading to crash. +This function is multitasking sleep - the program is halted, but it doesn't block other functions +e.g. callbacks from menus and icons. +The only argument here is the number of jiffies to wait until app will wake up. It depends on +video mode (PAL or NTSC) how many jiffies there are per second (50 or 60, respectively). +If you don't want to worry about it and need only full second resolution, call standard +System Functions @@ -1237,7 +1243,8 @@ up. You shouldn't use this unless you know what you are doing. These functions are called by some disk routines. You should call them only if you want to -do something with IO registers or call one of Kernal's routines. +do something with IO registers or call one of Kernal ROM routines. Note that this is rather an +expensive way of turning off IRQs and enabling IO. MainLoop

@@ -1252,10 +1259,9 @@ proper handlers before that.

-Calling this function will instantly terminate your program and bring you back to DeskTop. -WARNING! It is not an equivalent of ToBASIC

@@ -1263,7 +1269,9 @@ registered with This one is another way of finishing application - forcing GEOS to shutdown and exit to BASIC. I was considering whether to include it or not, but maybe someone will need it. Which is I doubt. -It has the same dangerous features as +Panic

@@ -1344,7 +1352,7 @@ definitions of returned values.

To simplify usage and optimize passing parameters to functions I have declared several structures which describe most common objects. Some of these structures are bound to static addresses in -GEOS data space ($8000-$8fff), so you can use their fields directly in optimized way. +GEOS data space ( This structure describes a font in one pointsize. There is current font -