mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-21 11:10:21 +02:00
Code Activity

(scm_async, scm_system_async, scm_async_mark, scm_system_async_mark,

Browse source 
scm_run_asyncs, scm_noop, scm_set_tick_rate, scm_set_switch_rate,
scm_unmask_signals, scm_mask_signals): Added docstrings.
This commit is contained in:
Martin Grabmüller 2001-02-16 15:22:58 +00:00
parent c73bdd3a73
commit 811cf8467a
1 changed files with 21 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

24
libguile/async.c
View file

@ -288,7 +288,7 @@ async_mark (SCM obj)
SCM_DEFINE (scm_async, "async", 1, 0, 0, SCM_DEFINE (scm_async, "async", 1, 0, 0,
(SCM thunk), (SCM thunk),
"") "Create a new async for the procedure @var{thunk}.")
#define FUNC_NAME s_scm_async #define FUNC_NAME s_scm_async
{ {
SCM_RETURN_NEWSMOB (tc16_async, SCM_UNPACK (thunk)); SCM_RETURN_NEWSMOB (tc16_async, SCM_UNPACK (thunk));
@ -297,7 +297,8 @@ SCM_DEFINE (scm_async, "async", 1, 0, 0,
SCM_DEFINE (scm_system_async, "system-async", 1, 0, 0, SCM_DEFINE (scm_system_async, "system-async", 1, 0, 0,
(SCM thunk), (SCM thunk),
"") "Create a new async for the procedure @var{thunk}. Also\n"
"add it to the system's list of active async objects.")
#define FUNC_NAME s_scm_system_async #define FUNC_NAME s_scm_system_async
{ {
SCM it; SCM it;
@ -314,7 +315,7 @@ SCM_DEFINE (scm_system_async, "system-async", 1, 0, 0,
SCM_DEFINE (scm_async_mark, "async-mark", 1, 0, 0, SCM_DEFINE (scm_async_mark, "async-mark", 1, 0, 0,
(SCM a), (SCM a),
"") "Mark the async @var{a} for future execution.")
#define FUNC_NAME s_scm_async_mark #define FUNC_NAME s_scm_async_mark
{ {
VALIDATE_ASYNC (1, a); VALIDATE_ASYNC (1, a);
@ -330,7 +331,7 @@ SCM_DEFINE (scm_async_mark, "async-mark", 1, 0, 0,
SCM_DEFINE (scm_system_async_mark, "system-async-mark", 1, 0, 0, SCM_DEFINE (scm_system_async_mark, "system-async-mark", 1, 0, 0,
(SCM a), (SCM a),
"") "Mark the async @var{a} for future execution.")
#define FUNC_NAME s_scm_system_async_mark #define FUNC_NAME s_scm_system_async_mark
{ {
VALIDATE_ASYNC (1, a); VALIDATE_ASYNC (1, a);
@ -350,7 +351,7 @@ SCM_DEFINE (scm_system_async_mark, "system-async-mark", 1, 0, 0,
SCM_DEFINE (scm_run_asyncs, "run-asyncs", 1, 0, 0, SCM_DEFINE (scm_run_asyncs, "run-asyncs", 1, 0, 0,
(SCM list_of_a), (SCM list_of_a),
"") "Execute all thunks from the asyncs of the list @var{list_of_a}.")
#define FUNC_NAME s_scm_run_asyncs #define FUNC_NAME s_scm_run_asyncs
{ {
#ifdef GUILE_OLD_ASYNC_CLICK #ifdef GUILE_OLD_ASYNC_CLICK
@ -383,7 +384,8 @@ SCM_DEFINE (scm_run_asyncs, "run-asyncs", 1, 0, 0,
SCM_DEFINE (scm_noop, "noop", 0, 0, 1, SCM_DEFINE (scm_noop, "noop", 0, 0, 1,
(SCM args), (SCM args),
"") "Do nothing. When called without arguments, return @code{#f},\n"
"otherwise return the first argument.")
#define FUNC_NAME s_scm_noop #define FUNC_NAME s_scm_noop
{ {
SCM_VALIDATE_REST_ARGUMENT (args); SCM_VALIDATE_REST_ARGUMENT (args);
@ -398,7 +400,8 @@ SCM_DEFINE (scm_noop, "noop", 0, 0, 1,
SCM_DEFINE (scm_set_tick_rate, "set-tick-rate", 1, 0, 0, SCM_DEFINE (scm_set_tick_rate, "set-tick-rate", 1, 0, 0,
(SCM n), (SCM n),
"") "Set the rate of async ticks to @var{n}. Return the old rate\n"
"value.")
#define FUNC_NAME s_scm_set_tick_rate #define FUNC_NAME s_scm_set_tick_rate
{ {
unsigned int old_n = scm_tick_rate; unsigned int old_n = scm_tick_rate;
@ -415,7 +418,8 @@ SCM_DEFINE (scm_set_tick_rate, "set-tick-rate", 1, 0, 0,
SCM_DEFINE (scm_set_switch_rate, "set-switch-rate", 1, 0, 0, SCM_DEFINE (scm_set_switch_rate, "set-switch-rate", 1, 0, 0,
(SCM n), (SCM n),
"") "Set the async switch rate to @var{n}. Return the old value\n"
"of the switch rate.")
#define FUNC_NAME s_scm_set_switch_rate #define FUNC_NAME s_scm_set_switch_rate
{ {
unsigned int old_n = scm_switch_rate; unsigned int old_n = scm_switch_rate;
@ -433,7 +437,7 @@ SCM_DEFINE (scm_set_switch_rate, "set-switch-rate", 1, 0, 0,
SCM_DEFINE (scm_unmask_signals, "unmask-signals", 0, 0, 0, SCM_DEFINE (scm_unmask_signals, "unmask-signals", 0, 0, 0,
(), (),
"") "Unmask signals. The returned value is not specified.")
#define FUNC_NAME s_scm_unmask_signals #define FUNC_NAME s_scm_unmask_signals
{ {
scm_mask_ints = 0; scm_mask_ints = 0;
@ -444,7 +448,7 @@ SCM_DEFINE (scm_unmask_signals, "unmask-signals", 0, 0, 0,
SCM_DEFINE (scm_mask_signals, "mask-signals", 0, 0, 0, SCM_DEFINE (scm_mask_signals, "mask-signals", 0, 0, 0,
(), (),
"") "Mask signals. The returned value is not specified.")
#define FUNC_NAME s_scm_mask_signals #define FUNC_NAME s_scm_mask_signals
{ {
scm_mask_ints = 1; scm_mask_ints = 1;