Add ProfilingBlockDevice API doc #320
Conversation
Delete that pesky Oxford comma.
| @@ -1,2 +1,15 @@ | |||
| ## ProfilingBlockDevice | |||
|
|
|||
| The ProfilingBlockDevice class provides a BlockDevice implementation to wrap around an existing block device object to log reads, writes and erases. | |||
There was a problem hiding this comment.
Content query: Is this too much like calling this a wrapper?
| @@ -1,2 +1,15 @@ | |||
| ## ProfilingBlockDevice | |||
|
|
|||
| The ProfilingBlockDevice class provides a BlockDevice implementation to wrap around an existing block device object to log reads, writes and erases. | |||
|
|
|||
| ProfilingBlockDevices take in a pointer to the block device being profiled as the only configurable parameter. All block device operations that wish to be logged need to be performed through the ProfilingBlockDevice object. | |||
There was a problem hiding this comment.
Query: What does it mean that the operations need to be performed through the object? Please clarify. Also, please stop personifying operations. They don't like it when you do that.
There was a problem hiding this comment.
In order for read, write, and erase calls to be counted, they need to be be called from the ProfilingBlockDevice object, not the underlying block device directly.
In other words given a block device object bd, and a profilingblockdevice object profiler pointing to bd you'd need to call
profiler.read(....);rather than
bd.read(...);I can rephrase that to be more clear and remove the personified operations.
There was a problem hiding this comment.
Ah. Makes sense. Please do. Thanks. 👍
|
@AnotherButler Rephrased the use case a bit. |
Delete another sneaky comma, and change passive to active voice.
|
@AnotherButler @pan- Updated the phrasing to use decorator. |
DEPENDENT ON ARMmbed/mbed-os#5395
The class reference link will be broken until the above PR is merged and the doxygen docs are regenerated.
@AnotherButler
@sg-