Skip to content

Commit 7374a0e

Browse files
committed
Add remarks
1 parent a63f5b6 commit 7374a0e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/api/storage/BlockDevice.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,14 @@ For details regarding how to configure the default block device please refer to
6363
#include <stdio.h>
6464
#include <algorithm>
6565
66+
// This will take the system's default block device
6667
BlockDevice *bd = BlockDevice::get_default_instance();
6768
69+
// Instead of the default block device, you can define your own block device.
70+
// For example: HeapBlockDevice with size of 2048 bytes, read size 1, write size 1 and erase size 512.
71+
// #include "HeapBlockDevice.h"
72+
// BlockDevice *bd = new HeapBlockDevice(2048, 1, 1, 512);
73+
6874
// Entry point for the example
6975
int main() {
7076
printf("--- Mbed OS block device example ---\n");

0 commit comments

Comments
 (0)