From b4b24f4b85fb1f57ba7a952b4c860247fb852bf5 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Wed, 26 May 1999 17:59:45 +0000 Subject: Regenerated to include more information in the stub. Now they have the descriptive titles. --- doc/itron3.0/config.t | 22 +++++++++++----------- doc/itron3.0/eventflags.t | 34 +++++++++++++++++----------------- doc/itron3.0/fixedblock.t | 30 +++++++++++++++--------------- doc/itron3.0/gen_section | 10 +++++++--- doc/itron3.0/interrupt.t | 38 +++++++++++++++++++------------------- doc/itron3.0/mailbox.t | 30 +++++++++++++++--------------- doc/itron3.0/memorypool.t | 30 +++++++++++++++--------------- doc/itron3.0/msgbuffer.t | 38 +++++++++++++++++++------------------- doc/itron3.0/network.t | 18 +++++++++--------- doc/itron3.0/rendezvous.t | 46 +++++++++++++++++++++++----------------------- doc/itron3.0/tasksync.t | 30 +++++++++++++++--------------- doc/itron3.0/time.t | 38 +++++++++++++++++++------------------- 12 files changed, 184 insertions(+), 180 deletions(-) (limited to 'doc') diff --git a/doc/itron3.0/config.t b/doc/itron3.0/config.t index 97b5440e88..773c44b339 100644 --- a/doc/itron3.0/config.t +++ b/doc/itron3.0/config.t @@ -16,18 +16,18 @@ system manager is ... The services provided by the system manager are: @itemize @bullet -@item @code{get_ver} - -@item @code{ref_sys} - -@item @code{ref_cfg} - -@item @code{def_svc} - -@item @code{def_exc} - +@item @code{get_ver} - Get Version Information Get Version Information of another Node +@item @code{ref_sys} - Reference Semaphore Status +@item @code{ref_cfg} - Reference Configuration Information +@item @code{def_svc} - Define Extended SVC Handler +@item @code{def_exc} - Define Exception Handler @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the system manager's services. A subsection is dedicated to each of this manager's services @@ -40,7 +40,7 @@ and status codes. @c @page -@subsection get_ver - +@subsection get_ver - Get Version Information Get Version Information of another Node @subheading CALLING SEQUENCE: @@ -68,7 +68,7 @@ int get_ver( @c @page -@subsection ref_sys - +@subsection ref_sys - Reference Semaphore Status @subheading CALLING SEQUENCE: @@ -96,7 +96,7 @@ int ref_sys( @c @page -@subsection ref_cfg - +@subsection ref_cfg - Reference Configuration Information @subheading CALLING SEQUENCE: @@ -124,7 +124,7 @@ int ref_cfg( @c @page -@subsection def_svc - +@subsection def_svc - Define Extended SVC Handler @subheading CALLING SEQUENCE: @@ -152,7 +152,7 @@ int def_svc( @c @page -@subsection def_exc - +@subsection def_exc - Define Exception Handler @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/eventflags.t b/doc/itron3.0/eventflags.t index 1e0f9ec727..475394595c 100644 --- a/doc/itron3.0/eventflags.t +++ b/doc/itron3.0/eventflags.t @@ -16,21 +16,21 @@ eventflags manager is ... The services provided by the eventflags manager are: @itemize @bullet -@item @code{cre_flg} - -@item @code{del_flg} - -@item @code{set_flg} - -@item @code{clr_flg} - -@item @code{wai_flg} - -@item @code{pol_flg} - -@item @code{twai_flg} - -@item @code{ref_flg} - +@item @code{cre_flg} - Create Eventflag +@item @code{del_flg} - Delete Eventflag +@item @code{set_flg} - Set Eventflag +@item @code{clr_flg} - Clear Eventflag +@item @code{wai_flg} - Wait on Eventflag with Timeout Wait on Eventflag +@item @code{pol_flg} - Wait for Eventflag (Polling) +@item @code{twai_flg} - Wait on Eventflag with Timeout +@item @code{ref_flg} - Reference Eventflag Status @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the eventflags manager's services. A subsection is dedicated to each of this manager's services @@ -43,7 +43,7 @@ and status codes. @c @page -@subsection cre_flg - +@subsection cre_flg - Create Eventflag @subheading CALLING SEQUENCE: @@ -71,7 +71,7 @@ int cre_flg( @c @page -@subsection del_flg - +@subsection del_flg - Delete Eventflag @subheading CALLING SEQUENCE: @@ -99,7 +99,7 @@ int del_flg( @c @page -@subsection set_flg - +@subsection set_flg - Set Eventflag @subheading CALLING SEQUENCE: @@ -127,7 +127,7 @@ int set_flg( @c @page -@subsection clr_flg - +@subsection clr_flg - Clear Eventflag @subheading CALLING SEQUENCE: @@ -155,7 +155,7 @@ int clr_flg( @c @page -@subsection wai_flg - +@subsection wai_flg - Wait on Eventflag with Timeout Wait on Eventflag @subheading CALLING SEQUENCE: @@ -183,7 +183,7 @@ int wai_flg( @c @page -@subsection pol_flg - +@subsection pol_flg - Wait for Eventflag (Polling) @subheading CALLING SEQUENCE: @@ -211,7 +211,7 @@ int pol_flg( @c @page -@subsection twai_flg - +@subsection twai_flg - Wait on Eventflag with Timeout @subheading CALLING SEQUENCE: @@ -239,7 +239,7 @@ int twai_flg( @c @page -@subsection ref_flg - +@subsection ref_flg - Reference Eventflag Status @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/fixedblock.t b/doc/itron3.0/fixedblock.t index 09c6153a12..cf727a5d8d 100644 --- a/doc/itron3.0/fixedblock.t +++ b/doc/itron3.0/fixedblock.t @@ -16,20 +16,20 @@ fixed block manager is ... The services provided by the fixed block manager are: @itemize @bullet -@item @code{cre_mpf} - -@item @code{del_mpf} - -@item @code{get_blf} - -@item @code{pget_blf} - -@item @code{tget_blf} - -@item @code{rel_blf} - -@item @code{ref_mpf} - +@item @code{cre_mpf} - Create Fixed-Size Memorypool +@item @code{del_mpf} - Delete Fixed-Size Memorypool +@item @code{get_blf} - Get Fixed-Size Memory Block Poll and Get Fixed-Size Memory Block Get Fixed-Size Memory Block with Timeout +@item @code{pget_blf} - Poll and Get Fixed-Size Memory Block +@item @code{tget_blf} - Get Fixed-Size Memory Block with Timeout +@item @code{rel_blf} - Release Fixed-Size Memory Block +@item @code{ref_mpf} - Reference Fixed-Size Memorypool Status @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the fixed block manager's services. A subsection is dedicated to each of this manager's services @@ -42,7 +42,7 @@ and status codes. @c @page -@subsection cre_mpf - +@subsection cre_mpf - Create Fixed-Size Memorypool @subheading CALLING SEQUENCE: @@ -70,7 +70,7 @@ int cre_mpf( @c @page -@subsection del_mpf - +@subsection del_mpf - Delete Fixed-Size Memorypool @subheading CALLING SEQUENCE: @@ -98,7 +98,7 @@ int del_mpf( @c @page -@subsection get_blf - +@subsection get_blf - Get Fixed-Size Memory Block Poll and Get Fixed-Size Memory Block Get Fixed-Size Memory Block with Timeout @subheading CALLING SEQUENCE: @@ -126,7 +126,7 @@ int get_blf( @c @page -@subsection pget_blf - +@subsection pget_blf - Poll and Get Fixed-Size Memory Block @subheading CALLING SEQUENCE: @@ -154,7 +154,7 @@ int pget_blf( @c @page -@subsection tget_blf - +@subsection tget_blf - Get Fixed-Size Memory Block with Timeout @subheading CALLING SEQUENCE: @@ -182,7 +182,7 @@ int tget_blf( @c @page -@subsection rel_blf - +@subsection rel_blf - Release Fixed-Size Memory Block @subheading CALLING SEQUENCE: @@ -210,7 +210,7 @@ int rel_blf( @c @page -@subsection ref_mpf - +@subsection ref_mpf - Reference Fixed-Size Memorypool Status @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/gen_section b/doc/itron3.0/gen_section index 0b069914b7..e82a793b25 100644 --- a/doc/itron3.0/gen_section +++ b/doc/itron3.0/gen_section @@ -126,7 +126,9 @@ echo "@itemize @bullet" for routine in ${ROUTINES} do - echo "@item @code{${routine}} - " + description=`grep ${routine} ../../itron_spec/itron3-1.txt | grep "]" | cut -d']' -f2` + description=`echo ${description}` + echo "@item @code{${routine}} - ${description}" done echo "@end itemize" @@ -135,7 +137,7 @@ echo "@section Background" echo "" echo "@section Operations" echo "" -echo "@section Directives" +echo "@section System Calls" echo "" echo "This section details the ${CHAPTER_LOWER} manager's services." echo "A subsection is dedicated to each of this manager's services" @@ -145,13 +147,15 @@ echo "" for routine in ${ROUTINES} do + description=`grep ${routine} ../../itron_spec/itron3-1.txt | grep "]" | cut -d']' -f2` + description=`echo ${description}` echo "" echo "@c" echo "@c ${routine}" echo "@c" echo "" echo "@page" - echo "@subsection ${routine} - " + echo "@subsection ${routine} - ${description}" echo "" echo "@subheading CALLING SEQUENCE:" echo "" diff --git a/doc/itron3.0/interrupt.t b/doc/itron3.0/interrupt.t index fa3e7e609c..4f6eb330a3 100644 --- a/doc/itron3.0/interrupt.t +++ b/doc/itron3.0/interrupt.t @@ -16,22 +16,22 @@ interrupt manager is ... The services provided by the interrupt manager are: @itemize @bullet -@item @code{def_int} - -@item @code{ret_int} - -@item @code{ret_wup} - -@item @code{loc_cpu} - -@item @code{unl_cpu} - -@item @code{dis_int} - -@item @code{ena_int} - -@item @code{chg_iXX} - -@item @code{ref_iXX} - +@item @code{def_int} - Define Interrupt Handler +@item @code{ret_int} - Return from Interrupt Handler +@item @code{ret_wup} - Return and Wakeup Task +@item @code{loc_cpu} - Lock CPU +@item @code{unl_cpu} - Unlock CPU +@item @code{dis_int} - Disable Interrupt +@item @code{ena_int} - Enable Interrupt +@item @code{chg_iXX} - Change Interrupt Mask (Level or Priority) +@item @code{ref_iXX} - Reference Interrupt Mask (Level or Priority) @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the interrupt manager's services. A subsection is dedicated to each of this manager's services @@ -44,7 +44,7 @@ and status codes. @c @page -@subsection def_int - +@subsection def_int - Define Interrupt Handler @subheading CALLING SEQUENCE: @@ -72,7 +72,7 @@ int def_int( @c @page -@subsection ret_int - +@subsection ret_int - Return from Interrupt Handler @subheading CALLING SEQUENCE: @@ -100,7 +100,7 @@ int ret_int( @c @page -@subsection ret_wup - +@subsection ret_wup - Return and Wakeup Task @subheading CALLING SEQUENCE: @@ -128,7 +128,7 @@ int ret_wup( @c @page -@subsection loc_cpu - +@subsection loc_cpu - Lock CPU @subheading CALLING SEQUENCE: @@ -156,7 +156,7 @@ int loc_cpu( @c @page -@subsection unl_cpu - +@subsection unl_cpu - Unlock CPU @subheading CALLING SEQUENCE: @@ -184,7 +184,7 @@ int unl_cpu( @c @page -@subsection dis_int - +@subsection dis_int - Disable Interrupt @subheading CALLING SEQUENCE: @@ -212,7 +212,7 @@ int dis_int( @c @page -@subsection ena_int - +@subsection ena_int - Enable Interrupt @subheading CALLING SEQUENCE: @@ -240,7 +240,7 @@ int ena_int( @c @page -@subsection chg_iXX - +@subsection chg_iXX - Change Interrupt Mask (Level or Priority) @subheading CALLING SEQUENCE: @@ -268,7 +268,7 @@ int chg_iXX( @c @page -@subsection ref_iXX - +@subsection ref_iXX - Reference Interrupt Mask (Level or Priority) @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/mailbox.t b/doc/itron3.0/mailbox.t index 36d678d331..b2a123ece9 100644 --- a/doc/itron3.0/mailbox.t +++ b/doc/itron3.0/mailbox.t @@ -16,20 +16,20 @@ mailbox manager is ... The services provided by the mailbox manager are: @itemize @bullet -@item @code{cre_mbx} - -@item @code{del_mbx} - -@item @code{snd_msg} - -@item @code{rcv_msg} - -@item @code{prcv_msg} - -@item @code{trcv_msg} - -@item @code{ref_mbx} - +@item @code{cre_mbx} - Create Mailbox +@item @code{del_mbx} - Delete Mailbox +@item @code{snd_msg} - Send Message to Mailbox +@item @code{rcv_msg} - Poll and Receive Message from Mailbox Receive Message from Mailbox Receive Message from Mailbox with Timeout +@item @code{prcv_msg} - Poll and Receive Message from Mailbox +@item @code{trcv_msg} - Receive Message from Mailbox with Timeout +@item @code{ref_mbx} - Reference Mailbox Status @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the mailbox manager's services. A subsection is dedicated to each of this manager's services @@ -42,7 +42,7 @@ and status codes. @c @page -@subsection cre_mbx - +@subsection cre_mbx - Create Mailbox @subheading CALLING SEQUENCE: @@ -70,7 +70,7 @@ int cre_mbx( @c @page -@subsection del_mbx - +@subsection del_mbx - Delete Mailbox @subheading CALLING SEQUENCE: @@ -98,7 +98,7 @@ int del_mbx( @c @page -@subsection snd_msg - +@subsection snd_msg - Send Message to Mailbox @subheading CALLING SEQUENCE: @@ -126,7 +126,7 @@ int snd_msg( @c @page -@subsection rcv_msg - +@subsection rcv_msg - Poll and Receive Message from Mailbox Receive Message from Mailbox Receive Message from Mailbox with Timeout @subheading CALLING SEQUENCE: @@ -154,7 +154,7 @@ int rcv_msg( @c @page -@subsection prcv_msg - +@subsection prcv_msg - Poll and Receive Message from Mailbox @subheading CALLING SEQUENCE: @@ -182,7 +182,7 @@ int prcv_msg( @c @page -@subsection trcv_msg - +@subsection trcv_msg - Receive Message from Mailbox with Timeout @subheading CALLING SEQUENCE: @@ -210,7 +210,7 @@ int trcv_msg( @c @page -@subsection ref_mbx - +@subsection ref_mbx - Reference Mailbox Status @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/memorypool.t b/doc/itron3.0/memorypool.t index 6e83c093b9..271bc85029 100644 --- a/doc/itron3.0/memorypool.t +++ b/doc/itron3.0/memorypool.t @@ -16,20 +16,20 @@ memory pool manager is ... The services provided by the memory pool manager are: @itemize @bullet -@item @code{cre_mpl} - -@item @code{del_mpl} - -@item @code{get_blk} - -@item @code{pget_blk} - -@item @code{tget_blk} - -@item @code{rel_blk} - -@item @code{ref_mpl} - +@item @code{cre_mpl} - Create Variable-Size Memorypool +@item @code{del_mpl} - Delete Variable-Size Memorypool +@item @code{get_blk} - Get Variable-Size Memory Block Poll and Get Variable-Size Memory Block Get Variable-Size Memory Block with Timeout +@item @code{pget_blk} - Poll and Get Variable-Size Memory Block +@item @code{tget_blk} - Get Variable-Size Memory Block with Timeout +@item @code{rel_blk} - Release Variable-Size Memory Block +@item @code{ref_mpl} - Reference Variable-Size Memorypool Status @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the memory pool manager's services. A subsection is dedicated to each of this manager's services @@ -42,7 +42,7 @@ and status codes. @c @page -@subsection cre_mpl - +@subsection cre_mpl - Create Variable-Size Memorypool @subheading CALLING SEQUENCE: @@ -70,7 +70,7 @@ int cre_mpl( @c @page -@subsection del_mpl - +@subsection del_mpl - Delete Variable-Size Memorypool @subheading CALLING SEQUENCE: @@ -98,7 +98,7 @@ int del_mpl( @c @page -@subsection get_blk - +@subsection get_blk - Get Variable-Size Memory Block Poll and Get Variable-Size Memory Block Get Variable-Size Memory Block with Timeout @subheading CALLING SEQUENCE: @@ -126,7 +126,7 @@ int get_blk( @c @page -@subsection pget_blk - +@subsection pget_blk - Poll and Get Variable-Size Memory Block @subheading CALLING SEQUENCE: @@ -154,7 +154,7 @@ int pget_blk( @c @page -@subsection tget_blk - +@subsection tget_blk - Get Variable-Size Memory Block with Timeout @subheading CALLING SEQUENCE: @@ -182,7 +182,7 @@ int tget_blk( @c @page -@subsection rel_blk - +@subsection rel_blk - Release Variable-Size Memory Block @subheading CALLING SEQUENCE: @@ -210,7 +210,7 @@ int rel_blk( @c @page -@subsection ref_mpl - +@subsection ref_mpl - Reference Variable-Size Memorypool Status @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/msgbuffer.t b/doc/itron3.0/msgbuffer.t index cd9118dce3..e8253e26f1 100644 --- a/doc/itron3.0/msgbuffer.t +++ b/doc/itron3.0/msgbuffer.t @@ -16,22 +16,22 @@ message buffer manager is ... The services provided by the message buffer manager are: @itemize @bullet -@item @code{cre_mbf} - -@item @code{del_mbf} - -@item @code{snd_mbf} - -@item @code{psnd_mbf} - -@item @code{tsnd_mbf} - -@item @code{rcv_mbf} - -@item @code{prcv_mbf} - -@item @code{trcv_mbf} - -@item @code{ref_mbf} - +@item @code{cre_mbf} - Create MessageBuffer +@item @code{del_mbf} - Delete MessageBuffer +@item @code{snd_mbf} - Poll and Send Message to MessageBuffer Send Message to MessageBuffer Send Message to MessageBuffer with Timeout +@item @code{psnd_mbf} - Poll and Send Message to MessageBuffer +@item @code{tsnd_mbf} - Send Message to MessageBuffer with Timeout +@item @code{rcv_mbf} - Poll and Receive Message from MessageBuffer Receive Message from MessageBuffer Receive Message from MessageBuffer with Timeout +@item @code{prcv_mbf} - Poll and Receive Message from MessageBuffer +@item @code{trcv_mbf} - Receive Message from MessageBuffer with Timeout +@item @code{ref_mbf} - Reference MessageBuffer Status @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the message buffer manager's services. A subsection is dedicated to each of this manager's services @@ -44,7 +44,7 @@ and status codes. @c @page -@subsection cre_mbf - +@subsection cre_mbf - Create MessageBuffer @subheading CALLING SEQUENCE: @@ -72,7 +72,7 @@ int cre_mbf( @c @page -@subsection del_mbf - +@subsection del_mbf - Delete MessageBuffer @subheading CALLING SEQUENCE: @@ -100,7 +100,7 @@ int del_mbf( @c @page -@subsection snd_mbf - +@subsection snd_mbf - Poll and Send Message to MessageBuffer Send Message to MessageBuffer Send Message to MessageBuffer with Timeout @subheading CALLING SEQUENCE: @@ -128,7 +128,7 @@ int snd_mbf( @c @page -@subsection psnd_mbf - +@subsection psnd_mbf - Poll and Send Message to MessageBuffer @subheading CALLING SEQUENCE: @@ -156,7 +156,7 @@ int psnd_mbf( @c @page -@subsection tsnd_mbf - +@subsection tsnd_mbf - Send Message to MessageBuffer with Timeout @subheading CALLING SEQUENCE: @@ -184,7 +184,7 @@ int tsnd_mbf( @c @page -@subsection rcv_mbf - +@subsection rcv_mbf - Poll and Receive Message from MessageBuffer Receive Message from MessageBuffer Receive Message from MessageBuffer with Timeout @subheading CALLING SEQUENCE: @@ -212,7 +212,7 @@ int rcv_mbf( @c @page -@subsection prcv_mbf - +@subsection prcv_mbf - Poll and Receive Message from MessageBuffer @subheading CALLING SEQUENCE: @@ -240,7 +240,7 @@ int prcv_mbf( @c @page -@subsection trcv_mbf - +@subsection trcv_mbf - Receive Message from MessageBuffer with Timeout @subheading CALLING SEQUENCE: @@ -268,7 +268,7 @@ int trcv_mbf( @c @page -@subsection ref_mbf - +@subsection ref_mbf - Reference MessageBuffer Status @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/network.t b/doc/itron3.0/network.t index dd882f6e22..7941a953e7 100644 --- a/doc/itron3.0/network.t +++ b/doc/itron3.0/network.t @@ -16,17 +16,17 @@ network support manager is ... The services provided by the network support manager are: @itemize @bullet -@item @code{nrea_dat} - -@item @code{nwri_dat} - -@item @code{nget_nod} - -@item @code{nget_ver} - +@item @code{nrea_dat} - Read Data from another Node +@item @code{nwri_dat} - Write Data to another Node +@item @code{nget_nod} - Get Local Node Number +@item @code{nget_ver} - Get Version Information of another Node @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the network support manager's services. A subsection is dedicated to each of this manager's services @@ -39,7 +39,7 @@ and status codes. @c @page -@subsection nrea_dat - +@subsection nrea_dat - Read Data from another Node @subheading CALLING SEQUENCE: @@ -67,7 +67,7 @@ int nrea_dat( @c @page -@subsection nwri_dat - +@subsection nwri_dat - Write Data to another Node @subheading CALLING SEQUENCE: @@ -95,7 +95,7 @@ int nwri_dat( @c @page -@subsection nget_nod - +@subsection nget_nod - Get Local Node Number @subheading CALLING SEQUENCE: @@ -123,7 +123,7 @@ int nget_nod( @c @page -@subsection nget_ver - +@subsection nget_ver - Get Version Information of another Node @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/rendezvous.t b/doc/itron3.0/rendezvous.t index 908d91985f..beca84d39f 100644 --- a/doc/itron3.0/rendezvous.t +++ b/doc/itron3.0/rendezvous.t @@ -16,24 +16,24 @@ rendezvous manager is ... The services provided by the rendezvous manager are: @itemize @bullet -@item @code{cre_por} - -@item @code{del_por} - -@item @code{cal_por} - -@item @code{pcal_por} - -@item @code{tcal_por} - -@item @code{acp_por} - -@item @code{pacp_por} - -@item @code{tacp_por} - -@item @code{fwd_por} - -@item @code{rpl_rdv} - -@item @code{ref_por} - +@item @code{cre_por} - Create Port for Rendezvous +@item @code{del_por} - Delete Port for Rendezvous +@item @code{cal_por} - Call Port for Rendezvous Poll and Call Port for Rendezvous Call Port for Rendezvous with Timeout +@item @code{pcal_por} - Poll and Call Port for Rendezvous +@item @code{tcal_por} - Call Port for Rendezvous with Timeout +@item @code{acp_por} - Accept Port for Rendezvous Poll and Accept Port for Rendezvous Accept Port for Rendezvous with Timeout +@item @code{pacp_por} - Poll and Accept Port for Rendezvous +@item @code{tacp_por} - Accept Port for Rendezvous with Timeout +@item @code{fwd_por} - Forward Rendezvous to Other Port +@item @code{rpl_rdv} - Reply Rendezvous +@item @code{ref_por} - Reference Port Status @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the rendezvous manager's services. A subsection is dedicated to each of this manager's services @@ -46,7 +46,7 @@ and status codes. @c @page -@subsection cre_por - +@subsection cre_por - Create Port for Rendezvous @subheading CALLING SEQUENCE: @@ -74,7 +74,7 @@ int cre_por( @c @page -@subsection del_por - +@subsection del_por - Delete Port for Rendezvous @subheading CALLING SEQUENCE: @@ -102,7 +102,7 @@ int del_por( @c @page -@subsection cal_por - +@subsection cal_por - Call Port for Rendezvous Poll and Call Port for Rendezvous Call Port for Rendezvous with Timeout @subheading CALLING SEQUENCE: @@ -130,7 +130,7 @@ int cal_por( @c @page -@subsection pcal_por - +@subsection pcal_por - Poll and Call Port for Rendezvous @subheading CALLING SEQUENCE: @@ -158,7 +158,7 @@ int pcal_por( @c @page -@subsection tcal_por - +@subsection tcal_por - Call Port for Rendezvous with Timeout @subheading CALLING SEQUENCE: @@ -186,7 +186,7 @@ int tcal_por( @c @page -@subsection acp_por - +@subsection acp_por - Accept Port for Rendezvous Poll and Accept Port for Rendezvous Accept Port for Rendezvous with Timeout @subheading CALLING SEQUENCE: @@ -214,7 +214,7 @@ int acp_por( @c @page -@subsection pacp_por - +@subsection pacp_por - Poll and Accept Port for Rendezvous @subheading CALLING SEQUENCE: @@ -242,7 +242,7 @@ int pacp_por( @c @page -@subsection tacp_por - +@subsection tacp_por - Accept Port for Rendezvous with Timeout @subheading CALLING SEQUENCE: @@ -270,7 +270,7 @@ int tacp_por( @c @page -@subsection fwd_por - +@subsection fwd_por - Forward Rendezvous to Other Port @subheading CALLING SEQUENCE: @@ -298,7 +298,7 @@ int fwd_por( @c @page -@subsection rpl_rdv - +@subsection rpl_rdv - Reply Rendezvous @subheading CALLING SEQUENCE: @@ -326,7 +326,7 @@ int rpl_rdv( @c @page -@subsection ref_por - +@subsection ref_por - Reference Port Status @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/tasksync.t b/doc/itron3.0/tasksync.t index 38c25d9de8..f349fb5f70 100644 --- a/doc/itron3.0/tasksync.t +++ b/doc/itron3.0/tasksync.t @@ -16,20 +16,20 @@ task-dependent synchronization manager is ... The services provided by the task-dependent synchronization manager are: @itemize @bullet -@item @code{sus_tsk} - -@item @code{rsm_tsk} - -@item @code{frsm_tsk} - -@item @code{slp_tsk} - -@item @code{tslp_tsk} - -@item @code{wup_tsk} - -@item @code{can_wup} - +@item @code{sus_tsk} - Suspend Other Task +@item @code{rsm_tsk} - Forcibly Resume Suspended Task Resume Suspended Task +@item @code{frsm_tsk} - Forcibly Resume Suspended Task +@item @code{slp_tsk} - Sleep Task Sleep Task with Timeout +@item @code{tslp_tsk} - Sleep Task with Timeout +@item @code{wup_tsk} - Wakeup Other Task +@item @code{can_wup} - Cancel Wakeup Request @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the task-dependent synchronization manager's services. A subsection is dedicated to each of this manager's services @@ -42,7 +42,7 @@ and status codes. @c @page -@subsection sus_tsk - +@subsection sus_tsk - Suspend Other Task @subheading CALLING SEQUENCE: @@ -70,7 +70,7 @@ int sus_tsk( @c @page -@subsection rsm_tsk - +@subsection rsm_tsk - Forcibly Resume Suspended Task Resume Suspended Task @subheading CALLING SEQUENCE: @@ -98,7 +98,7 @@ int rsm_tsk( @c @page -@subsection frsm_tsk - +@subsection frsm_tsk - Forcibly Resume Suspended Task @subheading CALLING SEQUENCE: @@ -126,7 +126,7 @@ int frsm_tsk( @c @page -@subsection slp_tsk - +@subsection slp_tsk - Sleep Task Sleep Task with Timeout @subheading CALLING SEQUENCE: @@ -154,7 +154,7 @@ No polling function for slp_tsk is provided. A similar function can be implemen @c tslp_tsk @c -@subsection tslp_tsk - +@subsection tslp_tsk - Sleep Task with Timeout @subsection tslp_tsk - Sleep Task with Timeout @subheading CALLING SEQUENCE: @@ -182,7 +182,7 @@ If you simply wish to delay a task (make it wait for a while), use dly_tsk rathe @c wup_tsk @c -@subsection wup_tsk - +@subsection wup_tsk - Wakeup Other Task @subsection wup_tsk - Wakeup Other Task @subheading CALLING SEQUENCE: @@ -210,7 +210,7 @@ An E_QOVR error will result if wup_tsk is issued more than the maximum value all @c can_wup @c -@subsection can_wup - +@subsection can_wup - Cancel Wakeup Request @subsection can_wup - Cancel Wakeup Request @subheading CALLING SEQUENCE: diff --git a/doc/itron3.0/time.t b/doc/itron3.0/time.t index f8c3985d36..ff61605cad 100644 --- a/doc/itron3.0/time.t +++ b/doc/itron3.0/time.t @@ -16,22 +16,22 @@ time manager is ... The services provided by the time manager are: @itemize @bullet -@item @code{get_tim} - -@item @code{set_tim} - -@item @code{dly_tsk} - -@item @code{def_cyc} - -@item @code{act_cyc} - -@item @code{ref_cyc} - -@item @code{def_alm} - -@item @code{ref_alm} - -@item @code{ret_tmr} - +@item @code{get_tim} - Get System Clock +@item @code{set_tim} - Set System Clock +@item @code{dly_tsk} - Delay Task +@item @code{def_cyc} - Define Cyclic Handler +@item @code{act_cyc} - Activate Cyclic Handler +@item @code{ref_cyc} - Reference Cyclic Handler Status +@item @code{def_alm} - Define Alarm Handler +@item @code{ref_alm} - Reference Alarm Handler Status +@item @code{ret_tmr} - Return from Timer Handler @end itemize @section Background @section Operations -@section Directives +@section System Calls This section details the time manager's services. A subsection is dedicated to each of this manager's services @@ -44,7 +44,7 @@ and status codes. @c @page -@subsection get_tim - +@subsection get_tim - Get System Clock @subheading CALLING SEQUENCE: @@ -72,7 +72,7 @@ int get_tim( @c @page -@subsection set_tim - +@subsection set_tim - Set System Clock @subheading CALLING SEQUENCE: @@ -100,7 +100,7 @@ int set_tim( @c @page -@subsection dly_tsk - +@subsection dly_tsk - Delay Task @subheading CALLING SEQUENCE: @@ -128,7 +128,7 @@ int dly_tsk( @c @page -@subsection def_cyc - +@subsection def_cyc - Define Cyclic Handler @subheading CALLING SEQUENCE: @@ -156,7 +156,7 @@ int def_cyc( @c @page -@subsection act_cyc - +@subsection act_cyc - Activate Cyclic Handler @subheading CALLING SEQUENCE: @@ -184,7 +184,7 @@ int act_cyc( @c @page -@subsection ref_cyc - +@subsection ref_cyc - Reference Cyclic Handler Status @subheading CALLING SEQUENCE: @@ -212,7 +212,7 @@ int ref_cyc( @c @page -@subsection def_alm - +@subsection def_alm - Define Alarm Handler @subheading CALLING SEQUENCE: @@ -240,7 +240,7 @@ int def_alm( @c @page -@subsection ref_alm - +@subsection ref_alm - Reference Alarm Handler Status @subheading CALLING SEQUENCE: @@ -268,7 +268,7 @@ int ref_alm( @c @page -@subsection ret_tmr - +@subsection ret_tmr - Return from Timer Handler @subheading CALLING SEQUENCE: -- cgit v1.2.3