Changes

Page history
Update How to deprecate authored by Guillaume Pasero's avatar Guillaume Pasero
Show whitespace changes
Inline Side-by-side
How-to-deprecate.md
View page @ 4e6c9a22
...@@ -24,4 +24,10 @@ AddDocTag(Tags::Deprecated); ...@@ -24,4 +24,10 @@ AddDocTag(Tags::Deprecated);
## An OTB module ## An OTB module
TODO *Soon*: Add the keyword `DEPRECATED` in the call to `otb-module()` macro in file `otb-module.cmake`
\ No newline at end of file
## How to disable deprecated features when `OTB_USE_DEPRECATED=OFF`?
* If you deprecate a whole module, it will be disabled during configure step.
* If you want to deprecated a C++ class and the associated tests: use variable `OTB_USE_DEPRECATED` to protect the inclusion of this class in `src/CMakeLists.txt`, `test/CMakeLists.txt`
* in otbConfigure.h, there is a macro `OTB_USE_DEPRECATED`, which is defined when CMake option `OTB_USE_DEPRECATED=ON`. Use it to disable portions of code in `test/otbXXXTestDriver.cxx` for instance