Merge pull request #5337 from kegilbert/heapblockdevice-ctor-doc

Add additional note on the HeapBlockDevice constructor block parameter
2017-10-19 16:40:10 +01:00 · 2017-10-19 16:40:10 +01:00 · 091660556b
parent e1090cafe1 1cfaa4a4e6
commit 091660556b
1 changed files with 2 additions and 1 deletions
--- a/features/filesystem/bd/HeapBlockDevice.h
+++ b/features/filesystem/bd/HeapBlockDevice.h
@ -56,7 +56,8 @@ public:
    /** Lifetime of the memory block device
     *
     * @param size      Size of the Block Device in bytes
-     * @param block     Block size in bytes
+     * @param block     Block size in bytes. Minimum read, program, and erase sizes are
+     *                  configured to this value
     */
    HeapBlockDevice(bd_size_t size, bd_size_t block=512);
    /** Lifetime of the memory block device