From: beutel Date: Thu, 14 Jun 2007 18:39:53 +0000 (+0000) Subject: repaired warnings on compilation to html X-Git-Tag: release_tools_1_2_4_1~120 X-Git-Url: https://oss.titaniummirror.com/gitweb/?a=commitdiff_plain;h=34a45b61ab8b5f5da9d63c717dd61721ba309d72;p=tinyos-2.x.git repaired warnings on compilation to html --- diff --git a/doc/txt/tep128.txt b/doc/txt/tep128.txt index 0fecf234..6584a6df 100644 --- a/doc/txt/tep128.txt +++ b/doc/txt/tep128.txt @@ -268,17 +268,17 @@ somewhere else on the non-volatile memory::: } -read(uint32_t addr, void *buf, uint32_t len); - - Read 'len' bytes into '*buf' from the given address +``read(uint32_t addr, void '*buf', uint32_t len);`` + - Read 'len' bytes into ``*buf`` from the given address - Returns FAIL if the volume is already in use - Signals readDone(...) when complete. -write(uint32_t addr, void *buf, uint32_t len); - - Write 'len' bytes from '*buf' starting at the given address +``write(uint32_t addr, void '*buf', uint32_t len);`` + - Write 'len' bytes from ``*buf`` starting at the given address - Returns FAIL if the volume is already in use - Signals writeDone(...) when complete. -erase(uint16_t eraseUnitIndex); +``erase(uint16_t eraseUnitIndex);`` - Erase a single 0-indexed erase unit - Returns FAIL if the volume is already in use - Signals eraseDone(...) when complete. @@ -354,37 +354,37 @@ a DirectStorage interface::: } -modify(uint32_t addr, void *buf, uint32_t len) +``modify(uint32_t addr, void *buf, uint32_t len)`` - Modify 'len' bytes located on non-volatile memory at the given address, replacing them with data from the given buffer - Returns FAIL if the volume is already in use - Signals modified(...) when the operation is complete -read(uint32_t addr, void *buf, uint32_t len) - - Read 'len' bytes into '*buf' from the given address +``read(uint32_t addr, void *buf, uint32_t len)`` + - Read 'len' bytes into ``*buf`` from the given address - Same as DirectStorage.read(...) - Returns FAIL if the volume is already in use - Signals readDone(...) when complete. -erase(uint16_t eraseUnitIndex); +``erase(uint16_t eraseUnitIndex);`` - Erase a single 0-indexed erase unit - Returns FAIL if the volume is already in use - Signals eraseDone(...) when complete. -flush() +``flush()`` - All data that has been previously written and is not yet located on non-volatile memory should be immediately stored to non-volatile memory. - Same behavior as flush() methods found in Java - Returns FAIL if the operation cannot be completed at this time - Signals flushDone(...) when complete. -crc(uint32_t addr, uint32_t len, uint16_t baseCrc); +``crc(uint32_t addr, uint32_t len, uint16_t baseCrc);`` - Calculate the CRC of 'len' bytes starting at the given address, using the given baseCrc as a seed. - Returns FAIL if the volume is already in use - Signals crcDone(...) when complete. -isSupported() +``isSupported()`` - Returns TRUE if DirectModify is available on the current memory type diff --git a/doc/txt/tep129.txt b/doc/txt/tep129.txt index 0a18781c..199bce51 100644 --- a/doc/txt/tep129.txt +++ b/doc/txt/tep129.txt @@ -107,13 +107,13 @@ unified BlockStorage interface::: } -read(uint32_t addr, void *buf, uint32_t len); - - Read 'len' bytes into '*buf' from the given address +``read(uint32_t addr, void *buf, uint32_t len);`` + - Read 'len' bytes into ``*buf`` from the given address - Returns FAIL if the request cannot be handled - Signals readDone(...) when complete. -write(uint32_t addr, void *buf, uint32_t len); - - Write 'len' bytes from '*buf' starting at the given address +``write(uint32_t addr, void *buf, uint32_t len);`` + - Write 'len' bytes from ``*buf`` starting at the given address - Returns FAIL if the request cannot be handled - Signals writeDone(...) when complete. @@ -375,15 +375,15 @@ getTotalKeys() - Determine the total number of valid keys stored on non-volatile memory - Signals totalKeys(...) when complete -insert(uint32_t key, void *value, uint16_t valueSize) +``insert(uint32_t key, void *value, uint16_t valueSize)`` - Insert some data into the configuration storage associated with the given key - Signals inserted(...) when complete -retrieve(uint32_t key, void *valueHolder, uint16_t maxValueSize) +``retrieve(uint32_t key, void *valueHolder, uint16_t maxValueSize)`` - Retrieve the value associated with the given key. The maximum value size is the maximum amount of data that can be loaded into the - *valueHolder location, to avoid overflow + ``*valueHolder`` location, to avoid overflow - Signals retrieved(...) when complete remove(uint32_t key)