summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1999-11-10 13:21:33 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1999-11-10 13:21:33 +0000
commitaff08f541b382a7757f73abd8e6e8357d5e09029 (patch)
treedb56a7c63c35209e888a479342be13a8be12c328 /doc
parentbab5ba444676a03c0aa92382d47dbd0830d05322 (diff)
downloadrtems-aff08f541b382a7757f73abd8e6e8357d5e09029.tar.bz2
Better formatting.
Diffstat (limited to 'doc')
-rw-r--r--doc/itron3.0/mailbox.t122
1 files changed, 75 insertions, 47 deletions
diff --git a/doc/itron3.0/mailbox.t b/doc/itron3.0/mailbox.t
index 6aee7547b3..ac476a10d2 100644
--- a/doc/itron3.0/mailbox.t
+++ b/doc/itron3.0/mailbox.t
@@ -1,4 +1,4 @@
-@c
+@c@*
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the mailbox
@c manager.
@@ -63,16 +63,18 @@ ER cre_mbx(
@subheading STATUS CODES:
-@code{E_OK} - Normal completion
-@code{E_NOMEM} - Insufficient memory
-@code{E_ID} - Invalid ID number
-@code{E_RSATR} - Reserved attribute
-@code{E_OBJ} - Invalid object state
-@code{E_OACV} - Object access violation
+@code{E_OK} - Normal completion@*
+@code{E_NOMEM} - Insufficient memory@*
+@code{E_ID} - Invalid ID number@*
+@code{E_RSATR} - Reserved attribute@*
+@code{E_OBJ} - Invalid object state@*
+@code{E_OACV} - Object access violation@*
@code{E_PAR} - Parameter error
-@subheading DESCRIPTION: Allocated a control area/buffer space for mailbox with some ID.
+@subheading DESCRIPTION:
+
+Allocated a control area/buffer space for mailbox with some ID.
User area: +ve ids
System area: -ve ids
User may specify if its FIFO or priority level queue.
@@ -81,6 +83,8 @@ Initializes core message queue for this mbox.
@subheading NOTES:
+NONE
+
@c
@c del_mbx
@@ -105,15 +109,19 @@ ER del_mbx(
@subheading STATUS CODES:
-@code{E_OK} - Normal completion
-@code{E_ID} - Invalid ID number
-@code{E_NOEXS} - Object does not exist
+@code{E_OK} - Normal completion@*
+@code{E_ID} - Invalid ID number@*
+@code{E_NOEXS} - Object does not exist@*
@code{E_OACV} - Object access violation
-@subheading DESCRIPTION: Specified by the ID, cleans up all data structures and control blocks.
+@subheading DESCRIPTION:
+
+Specified by the ID, cleans up all data structures and control blocks.
@subheading NOTES:
+NONE
+
@c
@c snd_msg
@@ -139,16 +147,20 @@ ER snd_msg(
@subheading STATUS CODES:
-@code{E_OK} - Normal completion
-@code{E_ID} - Invalid ID number
-@code{E_NOEXS} - Object does not exist
-@code{E_OACV} - Object access violation
+@code{E_OK} - Normal completion@*
+@code{E_ID} - Invalid ID number@*
+@code{E_NOEXS} - Object does not exist@*
+@code{E_OACV} - Object access violation@*
@code{E_QOVR} - Queueing or nesting overflow
-@subheading DESCRIPTION: Sends the address of message to mbox having a given id, any waiting tasks (blocked tasks) will be woken up. It supports non-blocking send.
+@subheading DESCRIPTION:
+
+Sends the address of message to mbox having a given id, any waiting tasks (blocked tasks) will be woken up. It supports non-blocking send.
@subheading NOTES:
+NONE
+
@c
@c rcv_msg
@@ -174,19 +186,23 @@ ER rcv_msg(
@subheading STATUS CODES:
-@code{E_OK} - Normal completion
-@code{E_ID} - Invalid ID number
-@code{E_NOEXS} - Object does not exist
-@code{E_OACV} - Object access violation
-@code{E_PAR} - Parameter error
-@code{E_DLT} - The object being waited for was deleted
-@code{E_RLWAI} - WAIT state was forcibly released
+@code{E_OK} - Normal completion@*
+@code{E_ID} - Invalid ID number@*
+@code{E_NOEXS} - Object does not exist@*
+@code{E_OACV} - Object access violation@*
+@code{E_PAR} - Parameter error@*
+@code{E_DLT} - The object being waited for was deleted@*
+@code{E_RLWAI} - WAIT state was forcibly released@*
@code{E_CTX} - Context error
-@subheading DESCRIPTION: If there is no message then receiver blocks, if not empty then it takes the first message of the queue.
+@subheading DESCRIPTION:
+
+If there is no message then receiver blocks, if not empty then it takes the first message of the queue.
@subheading NOTES:
+NONE
+
@c
@c prcv_msg
@@ -212,19 +228,23 @@ ER prcv_msg(
@subheading STATUS CODES:
-@code{E_OK} - Normal completion
-@code{E_ID} - Invalid ID number
-@code{E_NOEXS} - Object does not exist
-@code{E_OACV} - Object access violation
-@code{E_PAR} - Parameter error
-@code{E_DLT} - The object being waited for was deleted
-@code{E_RLWAI} - WAIT state was forcibly released
-@code{E_CTX} - Context error
+@code{E_OK} - Normal completion@*
+@code{E_ID} - Invalid ID number@*
+@code{E_NOEXS} - Object does not exist@*
+@code{E_OACV} - Object access violation@*
+@code{E_PAR} - Parameter error@*
+@code{E_DLT} - The object being waited for was deleted@*
+@code{E_RLWAI} - WAIT state was forcibly released@*
+@code{E_CTX} - Context error@*
-@subheading DESCRIPTION: Poll and receive message from mailbox.
+@subheading DESCRIPTION:
+
+Poll and receive message from mailbox.
@subheading NOTES:
+NONE
+
@c
@c trcv_msg
@@ -251,19 +271,23 @@ ER trcv_msg(
@subheading STATUS CODES:
-@code{E_OK} - Normal completion
-@code{E_ID} - Invalid ID number
-@code{E_NOEXS} - Object does not exist
-@code{E_OACV} - Object access violation
-@code{E_PAR} - Parameter error
-@code{E_DLT} - The object being waited for was deleted
-@code{E_RLWAI} - WAIT state was forcibly released
+@code{E_OK} - Normal completion@*
+@code{E_ID} - Invalid ID number@*
+@code{E_NOEXS} - Object does not exist@*
+@code{E_OACV} - Object access violation@*
+@code{E_PAR} - Parameter error@*
+@code{E_DLT} - The object being waited for was deleted@*
+@code{E_RLWAI} - WAIT state was forcibly released@*
@code{E_CTX} - Context error
-@subheading DESCRIPTION: Blocking receive with a maximum timeout.
+@subheading DESCRIPTION:
+
+Blocking receive with a maximum timeout.
@subheading NOTES:
+NONE
+
@c
@c ref_mbx
@@ -289,14 +313,18 @@ ER ref_mbx(
@subheading STATUS CODES:
-@code{E_OK} - Normal completion
-@code{E_ID} - Invalid ID number
-@code{E_NOEXS} - Object does not exist
-@code{E_OACV} - Object access violation
+@code{E_OK} - Normal completion@*
+@code{E_ID} - Invalid ID number@*
+@code{E_NOEXS} - Object does not exist@*
+@code{E_OACV} - Object access violation@*
@code{E_PAR} - Parameter error
-@subheading DESCRIPTION: Supports non-blocking receive. If there are no messages, it returns -1. Also returns id of the next process waiting on a message.
+@subheading DESCRIPTION:
+
+Supports non-blocking receive. If there are no messages, it returns -1. Also returns id of the next process waiting on a message.
@subheading NOTES:
+NONE
+