New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NVStore: add comments in header file for Doxygen formatting sake. #6359

Merged
merged 1 commit into from Mar 16, 2018

Conversation

Projects
None yet
7 participants
@davidsaada
Contributor

davidsaada commented Mar 14, 2018

Description

Enclosing NVStore class with comments for Doxygen sake.

Pull request type

  • Fix
@@ -50,6 +50,11 @@ typedef enum {
// defines 2 areas - active and nonactive, not configurable
#define NVSTORE_NUM_AREAS 2
/** NVStore class
*
* NVStore Class

This comment has been minimized.

@0xc0170

0xc0170 Mar 14, 2018

Member

NVStore Class

why is this doubled here?

This comment has been minimized.

@davidsaada

This comment has been minimized.

@0xc0170

0xc0170 Mar 14, 2018

Member

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).

This comment has been minimized.

@SenRamakri

SenRamakri Mar 14, 2018

Contributor

@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

@geky

This comment has been minimized.

Member

geky commented Mar 14, 2018

Hey @studavekar, is the doxy generation running on prs now? This would be a great pr to test it on.

@davidsaada davidsaada force-pushed the davidsaada:david_sotp_cpp branch from 128cf70 to f20c54e Mar 14, 2018

@davidsaada

This comment has been minimized.

Contributor

davidsaada commented Mar 14, 2018

Added a short description instead of the doubled text

@SenRamakri

Looks good.

@geky

geky approved these changes Mar 14, 2018

@0xc0170 0xc0170 added needs: CI and removed needs: review labels Mar 15, 2018

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Mar 15, 2018

/morph build

@mbed-ci

This comment has been minimized.

mbed-ci commented Mar 15, 2018

Build : SUCCESS

Build number : 1452
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6359/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

@mbed-ci

This comment has been minimized.

@studavekar

This comment has been minimized.

Collaborator

studavekar commented Mar 15, 2018

Hey @studavekar, is the doxy generation running on prs now? This would be a great pr to test it on.

@geky doxy generation should be available in docs dir http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6359/

@geky

This comment has been minimized.

Member

geky commented Mar 15, 2018

Ah, @studavekar very neat! So it's a part of the build step?

Here's the nvstore doxygen in case anyone is interested:
http://mbed-os.s3-eu-west-1.amazonaws.com/builds/6359/docs/html/classNVStore.html

@cmonr

This comment has been minimized.

Contributor

cmonr commented Mar 15, 2018

/morph test

@mbed-ci

This comment has been minimized.

@cmonr cmonr merged commit 0a1fc95 into ARMmbed:master Mar 16, 2018

19 checks passed

AWS-CI uVisor Build & Test Success
Details
ci-morph-build build completed
Details
ci-morph-exporter build completed
Details
ci-morph-mbed2-build build completed
Details
ci-morph-test test completed
Details
continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Local events testing has passed
Details
travis-ci/littlefs Passed, code size is 10060B (+0.00%)
Details
travis-ci/mbed2-ATMEL Local mbed2-ATMEL testing has passed
Details
travis-ci/mbed2-MAXIM Local mbed2-MAXIM testing has passed
Details
travis-ci/mbed2-NORDIC Local mbed2-NORDIC testing has passed
Details
travis-ci/mbed2-NUVOTON Local mbed2-NUVOTON testing has passed
Details
travis-ci/mbed2-NXP Local mbed2-NXP testing has passed
Details
travis-ci/mbed2-RENESAS Local mbed2-RENESAS testing has passed
Details
travis-ci/mbed2-SILICON_LABS Local mbed2-SILICON_LABS testing has passed
Details
travis-ci/mbed2-STM Local mbed2-STM testing has passed
Details
travis-ci/tools Local tools testing has passed
Details

@cmonr cmonr removed the ready for merge label Mar 16, 2018

@davidsaada davidsaada deleted the davidsaada:david_sotp_cpp branch Mar 20, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment