X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilccond.h;h=3774be21db93254b018f3fe39cd7e2ce1f06905c;hb=4d96aec5a0942c3b9bf66dcbec47c593f267c5ec;hp=08110d8145b1cbd24c0c1039ffe0c9f34f49cd6f;hpb=5c0580bfaa956973c2e292d98cb3df490c0a2fde;p=runtime.git diff --git a/lib/silcutil/silccond.h b/lib/silcutil/silccond.h index 08110d81..3774be21 100644 --- a/lib/silcutil/silccond.h +++ b/lib/silcutil/silccond.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - Copyright (C) 2006 - 2007 Pekka Riikonen + Copyright (C) 2006 - 2008 Pekka Riikonen This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -17,7 +17,7 @@ */ -/****h* silcutil/SILC Condition Variable Interface +/****h* silcutil/Condition Variable Interface * * DESCRIPTION * @@ -49,7 +49,7 @@ #ifndef SILCCOND_H #define SILCCOND_H -/****s* silcutil/SilcCondAPI/SilcCond +/****s* silcutil/SilcCond * * NAME * @@ -64,7 +64,7 @@ ***/ typedef struct SilcCondStruct *SilcCond; -/****s* silcutil/SilcCondAPI/silc_cond_alloc +/****f* silcutil/silc_cond_alloc * * SYNOPSIS * @@ -75,12 +75,13 @@ typedef struct SilcCondStruct *SilcCond; * Allocates SILC Condition variable context. The condition must * be allocated before it can be used. It is freed by the * silc_cond_free function. This returns TRUE and allocated - * condition in to the `cond' pointer and FALSE on error. + * condition in to the `cond' pointer and FALSE if system is out of + * memory. * ***/ SilcBool silc_cond_alloc(SilcCond *cond); -/****s* silcutil/SilcCondAPI/silc_cond_free +/****f* silcutil/silc_cond_free * * SYNOPSIS * @@ -94,7 +95,7 @@ SilcBool silc_cond_alloc(SilcCond *cond); ***/ void silc_cond_free(SilcCond cond); -/****s* silcutil/SilcCondAPI/silc_cond_wait +/****f* silcutil/silc_cond_wait * * SYNOPSIS * @@ -119,7 +120,7 @@ void silc_cond_free(SilcCond cond); ***/ void silc_cond_wait(SilcCond cond, SilcMutex mutex); -/****s* silcutil/SilcCondAPI/silc_cond_timedwait +/****f* silcutil/silc_cond_timedwait * * SYNOPSIS * @@ -139,7 +140,7 @@ void silc_cond_wait(SilcCond cond, SilcMutex mutex); ***/ SilcBool silc_cond_timedwait(SilcCond cond, SilcMutex mutex, int timeout); -/****s* silcutil/SilcCondAPI/silc_cond_signal +/****f* silcutil/silc_cond_signal * * SYNOPSIS * @@ -166,7 +167,7 @@ SilcBool silc_cond_timedwait(SilcCond cond, SilcMutex mutex, int timeout); ***/ void silc_cond_signal(SilcCond cond); -/****s* silcutil/SilcCondAPI/silc_cond_broadcast +/****f* silcutil/silc_cond_broadcast * * SYNOPSIS *