Skip to content

Minor Doxygen fixes for all file system classes #9305

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

Merged
merged 1 commit into from
Jan 11, 2019

Conversation

davidsaada
Copy link
Contributor

@davidsaada davidsaada 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 a team January 9, 2019 12:00
@ciarmcom
Copy link
Member

ciarmcom commented Jan 9, 2019

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

@davidsaada davidsaada force-pushed the david_littlefs_fatfs_doxy_fix branch from 23be723 to f52a6e8 Compare January 9, 2019 13:32
@cmonr
Copy link
Contributor

cmonr commented Jan 10, 2019

@davidsaada How does this PR interact with #9308?

@davidsaada
Copy link
Contributor Author

davidsaada 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 david_littlefs_fatfs_doxy_fix branch from e27eb92 to 1059c07 Compare January 10, 2019 13:07
@davidsaada
Copy link
Contributor Author

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

- Remove Doxygen generation on protected functions
- Minor description fixes
@davidsaada davidsaada force-pushed the david_littlefs_fatfs_doxy_fix branch from 1059c07 to 3c7924a Compare January 10, 2019 13:10
@davidsaada davidsaada changed the title Minor Doxygen fixes for LittleFS and FATFS Minor Doxygen fixes for all file system classes Jan 10, 2019
@cmonr
Copy link
Contributor

cmonr commented Jan 10, 2019

CI started

@mbed-ci
Copy link

mbed-ci 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
@davidsaada davidsaada deleted the david_littlefs_fatfs_doxy_fix branch January 14, 2019 09:58
@adbridge
Copy link
Contributor

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants