Skip to content
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

Minor Doxygen fixes for all file system classes #9305

Merged
merged 1 commit into from Jan 11, 2019

Conversation

Projects
None yet
8 participants
@davidsaada
Copy link
Contributor

commented Jan 9, 2019

Description

This PR includes minor fixes for all file system classes: Base class, LittleFS and FATFS.

  • Remove Doxygen generation on protected functions
  • Minor description fixes

Pull request type

Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[x] Docs update
[ ] Test update
[ ] Breaking change

@ciarmcom ciarmcom requested review from ARMmbed/mbed-os-maintainers Jan 9, 2019

@ciarmcom

This comment has been minimized.

Copy link
Member

commented Jan 9, 2019

@davidsaada, thank you for your changes.
@ARMmbed/mbed-os-storage @ARMmbed/mbed-os-maintainers please review.

Show resolved Hide resolved features/storage/filesystem/fat/FATFileSystem.h Outdated
Show resolved Hide resolved features/storage/filesystem/fat/FATFileSystem.h Outdated

@davidsaada davidsaada force-pushed the davidsaada:david_littlefs_fatfs_doxy_fix branch Jan 9, 2019

@GuyWi GuyWi removed the needs: review label Jan 9, 2019

@cmonr cmonr added the needs: review label Jan 9, 2019

@cmonr

This comment has been minimized.

Copy link
Contributor

commented Jan 10, 2019

@davidsaada How does this PR interact with #9308?

@davidsaada

This comment has been minimized.

Copy link
Contributor Author

commented Jan 10, 2019

@davidsaada How does this PR interact with #9308?

We'll need to merge them. This one originally modified the Doxy for LittleFS and FAT FS, but then I noticed that they were all copied from FileSystem base class, so I propagated the changes there as well. #9308 made other changes on the base class separately.

@davidsaada davidsaada force-pushed the davidsaada:david_littlefs_fatfs_doxy_fix branch Jan 10, 2019

@davidsaada

This comment has been minimized.

Copy link
Contributor Author

commented Jan 10, 2019

Took all relevant changes from #9308 and squashed all commits.

Minor Doxygen fixes for all file system classes
- Remove Doxygen generation on protected functions
- Minor description fixes

@davidsaada davidsaada force-pushed the davidsaada:david_littlefs_fatfs_doxy_fix branch to 3c7924a Jan 10, 2019

@davidsaada davidsaada changed the title Minor Doxygen fixes for LittleFS and FATFS Minor Doxygen fixes for all file system classes Jan 10, 2019

@cmonr

cmonr approved these changes Jan 10, 2019

@cmonr

This comment has been minimized.

Copy link
Contributor

commented Jan 10, 2019

CI started

@cmonr cmonr added needs: CI and removed needs: review labels Jan 10, 2019

@mbed-ci

This comment has been minimized.

Copy link

commented Jan 11, 2019

Test run: SUCCESS

Summary: 11 of 11 test jobs passed
Build number : 1
Build artifacts

@0xc0170 0xc0170 merged commit 307bdd7 into ARMmbed:master Jan 11, 2019

21 checks passed

continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
jenkins-ci/build-ARM Success
Details
jenkins-ci/build-GCC_ARM Success
Details
jenkins-ci/build-IAR Success
Details
jenkins-ci/cloud-client-test Success
Details
jenkins-ci/dynamic-memory-usage RTOS ROM(+0 bytes) RAM(+0 bytes)
Details
jenkins-ci/exporter Success
Details
jenkins-ci/greentea-test Success
Details
jenkins-ci/mbed2-build-ARM Success
Details
jenkins-ci/mbed2-build-GCC_ARM Success
Details
jenkins-ci/mbed2-build-IAR Success
Details
jenkins-ci/unittests Success
Details
travis-ci/astyle Local astyle testing has passed
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Passed, runtime is 9301 cycles
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8372B
Details
travis-ci/psa-autogen Local psa-autogen testing has passed
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details

@davidsaada davidsaada deleted the davidsaada:david_littlefs_fatfs_doxy_fix branch Jan 14, 2019

@adbridge

This comment has been minimized.

Copy link
Contributor

commented Jan 14, 2019

This is sitting on top of #8972 which is a major feature for 5.12 so this is being moved to 5.12 also.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.