From 12e9abc928dab60030a8958fe72968005a1a0c52 Mon Sep 17 00:00:00 2001 From: beutel Date: Thu, 14 Jun 2007 18:25:26 +0000 Subject: [PATCH] repaired warnings on comilation to html --- doc/txt/tep118.txt | 2 +- doc/txt/tep127.txt | 32 +++++++++++++++++++------------- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/doc/txt/tep118.txt b/doc/txt/tep118.txt index 5ffb7ba3..48ab4e4c 100644 --- a/doc/txt/tep118.txt +++ b/doc/txt/tep118.txt @@ -113,7 +113,7 @@ which has the following signature:: provides interface DisseminationUpdate ; } -The t argument MUST be able to fit in a single message_t[tep111_] after +The t argument MUST be able to fit in a single message_t [TEP111] after considering the headers that the dissemination protocol introduces. A dissemination implementation SHOULD have a compile error if a larger type than this is used. diff --git a/doc/txt/tep127.txt b/doc/txt/tep127.txt index 83408ecc..d17f5da8 100644 --- a/doc/txt/tep127.txt +++ b/doc/txt/tep127.txt @@ -103,24 +103,30 @@ The TEP proposes this PacketLink interface::: command bool wasDelivered(message_t *msg); } +PacketLinks interface functions: -setRetries(message_t *msg, uint16_t maxRetries) - - Sets the maximum number of times to retry the transmission of the message + ``setRetries(message_t *msg, uint16_t maxRetries)`` -setRetryDelay(message_t *msg, uint16_t retryDelay) - - Set the delay, in milliseconds, between each retransmission +- Sets the maximum number of times to retry the transmission of the message -getRetries(message_t *msg) - - Returns the maximum number of retries configured for the given message + ``setRetryDelay(message_t *msg, uint16_t retryDelay)`` -getRetryDelay(message_t *msg) - - Returns the delay, in milliseconds, between each retransmission for the - given message +- Set the delay, in milliseconds, between each retransmission -wasDelivered(message_t *msg) - - This command may be called after the sendDone() event is signaled. It - is the equivalent of PacketAcknowledgements.wasAcked(message_t *msg), so - is only a helper function to make the PacketLink interface easier to use. + ``getRetries(message_t *msg)`` + +- Returns the maximum number of retries configured for the given message + + ``getRetryDelay(message_t *msg)`` + +- Returns the delay, in milliseconds, between each retransmission for the given + message + + ``wasDelivered(message_t *msg)`` + +- This command may be called after the sendDone() event is signaled. It is the + equivalent of ``PacketAcknowledgements.wasAcked(message_t *msg)``, so is only + a helper function to make the PacketLink interface easier to use. -- 2.39.2