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

Fix doxygen comments to reflect the deprecated functions #6531

Merged
merged 1 commit into from Apr 6, 2018

Conversation

Projects
None yet
6 participants
@SenRamakri
Contributor

SenRamakri commented Apr 3, 2018

Description

Fix doxygen comments to reflect the deprecated APIs in Mbed-OS.

Pull request type

[X ] Fix
[ ] Refactor
[ ] New target
[ ] Feature
[ ] Breaking change

@SenRamakri SenRamakri requested review from sg- and kegilbert Apr 3, 2018

@cmonr

This comment has been minimized.

Contributor

cmonr commented Apr 3, 2018

General question. Do we have two different deprecated warnings that we use?

There's this PR, which marks the deprecation in doxygen, but then we also have this: https://github.com/ARMmbed/mbed-os/pull/6264/files#diff-a1349b6ff207a9467417014cc6d2f4ccR32

Do we need both in this PR?

@cmonr cmonr added the needs: review label Apr 3, 2018

@sg-

sg- approved these changes Apr 3, 2018 edited

There are 2 steps needed to complete an API deprecation.

  1. MBED_DEPRECATED_SINCE macro for compile time indication
  2. Doxygen documentation of the deprecation.

This PR adds the missing doxygen labels for existing MBED_DEPRECATED_SINCE usage. There are a lot more of these to come. https://github.com/ARMmbed/mbed-os/pull/6531/files#diff-0fb05c4ba9c4414d7a6c0601671b77c6R75

@cmonr

This comment has been minimized.

Contributor

cmonr commented Apr 3, 2018

/morph build

@cmonr cmonr added needs: CI and removed needs: review labels Apr 3, 2018

@cmonr

This comment has been minimized.

Contributor

cmonr commented Apr 3, 2018

👍

@mbed-ci

This comment has been minimized.

mbed-ci commented Apr 3, 2018

Build : SUCCESS

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

Triggering tests

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

@mbed-ci

This comment has been minimized.

@0xc0170

0xc0170 approved these changes Apr 4, 2018

@mbed-ci

This comment has been minimized.

@0xc0170 0xc0170 added ready for merge and removed needs: CI labels Apr 4, 2018

@0xc0170 0xc0170 merged commit 3328ecd into ARMmbed:master Apr 6, 2018

11 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 Passed, runtime is 8991 cycles (+64 cycles)
Details
travis-ci/littlefs Passed, code size is 10092B (+0.00%)
Details
travis-ci/tools Local tools testing has passed
Details

@0xc0170 0xc0170 removed the ready for merge label Apr 6, 2018

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