Skip to content

Commit dfde774

Browse files
committed
DOC: Re-use README.rst info in itk-module.cmake.
Re-use `README.rst` info in `itk-module.cmake`. Helps avoiding duplications/diverging versions of the documentation.
1 parent c5920ba commit dfde774

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

itk-module.cmake

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
set( DOCUMENTATION "This module contains filter called
2-
itk::SplitComponentsImageFilter. This filter generates component images from an
3-
itk::Image of, for example, itk::Vector, itk::CovariantVector, or
4-
itk::SymmetricSecondRankTensor." )
1+
# the top-level README is used for describing this module, just
2+
# re-used it for documentation here
3+
get_filename_component(MY_CURRENT_DIR "${CMAKE_CURRENT_LIST_FILE}" PATH)
4+
file(READ "${MY_CURRENT_DIR}/README.rst" DOCUMENTATION)
55

6+
# itk_module() defines the module dependencies in SplitComponents
7+
# The testing module in SplitComponents depends on ITKTestKernel
8+
# By convention those modules outside of ITK are not prefixed with
9+
# ITK.
10+
11+
# define the dependencies of the include module and the tests
612
itk_module(SplitComponents
713
DEPENDS
814
ITKCommon

0 commit comments

Comments
 (0)