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

Improve deprecation of BLE API features #152

Open
pan- opened this issue Dec 18, 2015 · 0 comments
Open

Improve deprecation of BLE API features #152

pan- opened this issue Dec 18, 2015 · 0 comments

Comments

@pan-
Copy link
Member

pan- commented Dec 18, 2015

Deprecation of features of BLE API can be more visible to end user. There is two ways to improve this:

  • Documentation: doxygen support a directive for deprecated elements: \deprecated. This tag should be use for all deprecated entities in BLE API.
  • Warning at compile time: compiler-polyfill now support a __deprecated_message macro. It can be used to provide a usefull information about deprecated feature at compilation time. This feature can be used to tag the following entities:
    • functions: void foo(void) __deprecated_message("This function is deprecated, use void bar(void) instead")
    • variables: int foo __deprecated_message("This variable is deprecated, use bar instead") = 0;
    • variables: int foo __deprecated_message("This variable is deprecated, use bar instead") = 0;
    • types: class Foo __deprecated_message("Foo class is deprecated, use Bar instead") { };
    • typedef: typedef Foo Bar __deprecated_message("This typedef is deprecated, use Baz instead")
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant