IOT-1375 Add OC_DEPRECATED macros 11/23111/12
authorGeorge Nash <george.nash@intel.com>
Thu, 9 Nov 2017 17:50:03 +0000 (09:50 -0800)
committerDave Thaler <dthaler@microsoft.com>
Thu, 4 Jan 2018 20:20:15 +0000 (20:20 +0000)
commit333b662fc759599efae246ba540a5fe3d6deb6f6
tree48be914ee9752bfae758188b2878bc534e9a4824
parent54db42cdbf1ff525a94904412a819cd4a25bdd60
IOT-1375 Add OC_DEPRECATED macros

This add macros that enable marking deprecated for the compiler
This will add compiler specific annotations that will
cause compiler warnings when a deprecated function is used.

Adding the date the function was deprecated, was inspired by
the AllJoyn project. Adding the date a function or class was
deprecated can help when deciding to remove deprecated code.

The doxygen config files were modified to expand the macros
so doxygen properly documents the deprecated function not the
OC_DEPRECATED macro itself.

The macro was then used to mark the base64 implementation
deprecated. Since the base64 implementation is currently placed
in the public header files we should mark it as deprecated giving
other users time to move their code to the mbedtls
implementation.

Change-Id: I6e13e34caf84311e555d19aeb393e922d09d4b59
Signed-off-by: George Nash <george.nash@intel.com>
resource/c_common/platform_features.h
resource/csdk/security/include/base64.h
resource/csdk/security/unittest/SConscript
resource/docs/c-doc/Doxyfile
resource/docs/c-doc/devdocs.doxyfile
resource/docs/cpp-doc/Doxyfile
resource/docs/cpp-doc/devdocs.doxyfile