NVStore: add comments in header file for Doxygen formatting sake. #6359
Conversation
features/nvstore/source/nvstore.h
Outdated
| @@ -50,6 +50,11 @@ typedef enum { | |||
| // defines 2 areas - active and nonactive, not configurable | |||
| #define NVSTORE_NUM_AREAS 2 | |||
|
|
|||
| /** NVStore class | |||
| * | |||
| * NVStore Class | |||
There was a problem hiding this comment.
NVStore Class
why is this doubled here?
There was a problem hiding this comment.
@SenRamakri @AnotherButler Care to answer?
There was a problem hiding this comment.
I would expect here something similar to https://github.com/ARMmbed/mbed-os/blob/master/platform/FileBase.h#L36, even an example how to use this object (some drivers have it).
There was a problem hiding this comment.
@davidsaada - Can you please add some description of what that class is? For example, see - https://github.com/ARMmbed/mbed-os/blob/master/features/cellular/easy_cellular/EasyCellularConnection.h#L30
|
Hey @studavekar, is the doxy generation running on prs now? This would be a great pr to test it on. |
128cf70 to
f20c54e
Compare
|
Added a short description instead of the doubled text |
|
/morph build |
Build : SUCCESSBuild number : 1452 Triggering tests/morph test |
Exporter Build : SUCCESSBuild number : 1090 |
@geky doxy generation should be available in docs dir http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6359/ |
|
Ah, @studavekar very neat! So it's a part of the build step? Here's the nvstore doxygen in case anyone is interested: |
|
/morph test |
Description
Enclosing NVStore class with comments for Doxygen sake.
Pull request type