]> oss.titaniummirror.com Git - tinyos-2.x.git/commitdiff
repaired warnings on compilation to html
authorbeutel <beutel>
Thu, 14 Jun 2007 18:39:53 +0000 (18:39 +0000)
committerbeutel <beutel>
Thu, 14 Jun 2007 18:39:53 +0000 (18:39 +0000)
doc/txt/tep128.txt
doc/txt/tep129.txt

index 0fecf2346936147849fe3382177d906839b36509..6584a6df000d7355a33d8836fb2678f1475e317e 100644 (file)
@@ -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
 
 
index 0a18781cd313ea58c797620be52793fcc6a8e5f1..199bce5167bc97a56229d5d13dbf26d76a3f6e01 100644 (file)
@@ -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)