Skip to content

Commit 84e830c

Browse files
author
AnotherButler
committed
Add class hierarchy images to storage section
Add class hierarchy diagrams to storage APIs as test.
1 parent c2dae27 commit 84e830c

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

docs/reference/api/storage/ChainingBlockDevice.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## ChainingBlockDevice
22

3+
<span class="images">![](https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_chaining_block_device.png)<span>ChainingBlockDevice class hierarchy</span></span>
4+
35
The ChainingBlockDevice class provides a way to chain together multiple block devices. You can then interact with the chained block devices as if they were a single block device of size equal to the sum of each substorage unit. The ChainingBlockDevice acts as an opposite of the [SlicingBlockDevice](/docs/development/reference/slicingblockdevice.html).
46

57
Note that each block device's block size must be a multiple of the other devices' block sizes (512, 1024 and so on).

docs/reference/api/storage/HeapBlockDevice.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## HeapBlockDevice
22

3+
<span class="images">![](https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_heap_block_device.png)<span>BlockDevice class hierarchy</span></span>
4+
35
The HeapBlockDevice class provides a way to simulate block devices for software development or testing. The created blocks are nonvolatile; they do not persist across power cycles.
46

57
HeapBlockDevices have the following configurable parameters in either one of two constructors:

docs/reference/api/storage/MBRBlockDevice.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## MBRBlockDevice
22

3+
<span class="images">![](https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_m_b_r_block_device.png)<span>MBRBlockDevice class hierarchy</span></span>
4+
35
The MBRBlockDevice class provides a way to manage a Master Boot Record (MBR) on a storage device, which allows you to partition the device. Without the MBR, you can still format a storage device with a file system, but including the MBR will allow for future partition modifications.
46

57
MBRBlockDevices have the following configurable parameters in the constructor:

0 commit comments

Comments
 (0)