Doxygen changes to ProfilingBlockDevice and SlicingBlockDevice.

Author: Yossi Levy

features/storage/blockdevice/ProfilingBlockDevice.h

@@ -32,22 +32,6 @@ namespace mbed {
 
 
 /** Block device for measuring storage operations of another block device
- *
- *  @code
- *  #include "mbed.h"
- *  #include "HeapBlockDevice.h"
- *  #include "ProfilingBlockDevice.h"
- *
- *  // Create a heap block device and profiling block device
- *  HeapBlockDevice mem(64*512, 512);
- *  ProfilingBlockDevice profiler(&mem);
- *
- *  // do block device work....
- *
- *  printf("read count: %lld\n", profiler.get_read_count());
- *  printf("program count: %lld\n", profiler.get_program_count());
- *  printf("erase count: %lld\n", profiler.get_erase_count());
- *  @endcode
  */
 class ProfilingBlockDevice : public BlockDevice {
 public:
@@ -86,7 +70,7 @@ class ProfilingBlockDevice : public BlockDevice {
      *  @param buffer   Buffer to read blocks into
      *  @param addr     Address of block to begin reading from
      *  @param size     Size to read in bytes, must be a multiple of read block size
-     *  @return         0 on success, negative error code on failure
+     *  @return         0 on success or a negative error code on failure
      */
     virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
 
@@ -97,7 +81,7 @@ class ProfilingBlockDevice : public BlockDevice {
      *  @param buffer   Buffer of data to write to blocks
      *  @param addr     Address of block to begin writing to
      *  @param size     Size to write in bytes, must be a multiple of program block size
-     *  @return         0 on success, negative error code on failure
+     *  @return         0 on success or a negative error code on failure
      */
     virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
 
@@ -108,7 +92,7 @@ class ProfilingBlockDevice : public BlockDevice {
      *
      *  @param addr     Address of block to begin erasing
      *  @param size     Size to erase in bytes, must be a multiple of erase block size
-     *  @return         0 on success, negative error code on failure
+     *  @return         0 on success or a negative error code on failure
      */
     virtual int erase(bd_addr_t addr, bd_size_t size);
 

features/storage/blockdevice/SlicingBlockDevice.h

@@ -32,24 +32,6 @@
 namespace mbed {
 
 /** Block device for mapping to a slice of another block device
- *
- *  @code
- *  #include "mbed.h"
- *  #include "HeapBlockDevice.h"
- *  #include "SlicingBlockDevice.h"
- *
- *  // Create a block device with 64 blocks of size 512
- *  HeapBlockDevice mem(64*512, 512);
- *
- *  // Create a block device that maps to the first 32 blocks
- *  SlicingBlockDevice slice1(&mem, 0*512, 32*512);
- *
- *  // Create a block device that maps to the last 32 blocks
- *  SlicingBlockDevice slice2(&mem, 32*512);
- *
- *  // Create a block device that maps to the middle 32 blocks
- *  SlicingBlockDevice slice3(&mem, 16*512, -16*512);
- * @endcode
  */
 class SlicingBlockDevice : public BlockDevice {
 public:
@@ -92,7 +74,7 @@ class SlicingBlockDevice : public BlockDevice {
      *  @param buffer   Buffer to read blocks into
      *  @param addr     Address of block to begin reading from
      *  @param size     Size to read in bytes, must be a multiple of read block size
-     *  @return         0 on success, negative error code on failure
+     *  @return         0 on success or a negative error code on failure
      */
     virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
 
@@ -103,7 +85,7 @@ class SlicingBlockDevice : public BlockDevice {
      *  @param buffer   Buffer of data to write to blocks
      *  @param addr     Address of block to begin writing to
      *  @param size     Size to write in bytes, must be a multiple of program block size
-     *  @return         0 on success, negative error code on failure
+     *  @return         0 on success or a negative error code on failure
      */
     virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
 
@@ -114,7 +96,7 @@ class SlicingBlockDevice : public BlockDevice {
      *
      *  @param addr     Address of block to begin erasing
      *  @param size     Size to erase in bytes, must be a multiple of erase block size
-     *  @return         0 on success, negative error code on failure
+     *  @return         0 on success or a negative error code on failure
      */
     virtual int erase(bd_addr_t addr, bd_size_t size);