BUG: Fix LineSpatialObject example

mseng10 · mseng10 · commit 070d9d26be92 · 2021-01-26T11:54:18.000-06:00
This example should be renamed to LineSpatialObject, not LineSpatialObject2.

In addition, the breathelink has been suppressed for a future commit.
Once the documentation is pushed to the official itk.org, this can be
uncommnented.

The reason for this is because the doxygen tries to find a
url that is not present. Hence, once it is pressent the error will be
fixed.
diff --git a/src/Core/SpatialObjects/CMakeLists.txt b/src/Core/SpatialObjects/CMakeLists.txt
@@ -8,8 +8,8 @@ compare_to_baseline(EXAMPLE_NAME Ellipse
   BASELINE_PREFIX EllipseOutput
   )
 
-add_example(LineSpatialObject2)
-compare_to_baseline(EXAMPLE_NAME LineSpatialObject2
+add_example(LineSpatialObject)
+compare_to_baseline(EXAMPLE_NAME LineSpatialObject
   BASELINE_PREFIX line
   )
 
diff --git a/src/Core/SpatialObjects/LineSpatialObject/CMakeLists.txt b/src/Core/SpatialObjects/LineSpatialObject/CMakeLists.txt
@@ -1,26 +1,26 @@
 cmake_minimum_required(VERSION 3.10.2)
 
-project(LineSpatialObject2)
+project(LineSpatialObject)
 
 find_package(ITK REQUIRED)
 include(${ITK_USE_FILE})
 
 
-add_executable(LineSpatialObject2 Code.cxx)
-target_link_libraries(LineSpatialObject2 ${ITK_LIBRARIES})
+add_executable(LineSpatialObject Code.cxx)
+target_link_libraries(LineSpatialObject ${ITK_LIBRARIES})
 
-install(TARGETS LineSpatialObject2
+install(TARGETS LineSpatialObject
   DESTINATION bin/ITKExamples/Core/SpatialObjects
   COMPONENT Runtime
   )
 
 install(FILES Code.cxx CMakeLists.txt
-  DESTINATION share/ITKExamples/Code/Core/SpatialObjects/LineSpatialObject2/
+  DESTINATION share/ITKExamples/Code/Core/SpatialObjects/LineSpatialObject/
   COMPONENT Code
   )
 
 
 enable_testing()
-add_test(NAME LineSpatialObject2Test
-  COMMAND ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/LineSpatialObject2)
+add_test(NAME LineSpatialObjectTest
+  COMMAND ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/LineSpatialObject)
 
diff --git a/src/Core/SpatialObjects/LineSpatialObject/Code.cxx b/src/Core/SpatialObjects/LineSpatialObject/Code.cxx
diff --git a/src/Core/SpatialObjects/LineSpatialObject/Documentation.rst b/src/Core/SpatialObjects/LineSpatialObject/Documentation.rst
@@ -1,4 +1,4 @@
-Line Spacial Object
+Line Spatial Object
 ===================
 
 .. index::
@@ -30,6 +30,6 @@ C++
 
 Classes demonstrated
 --------------------
-
-.. breathelink:: itk::LineSpatialObject
-.. breathelink:: itk::LineSpatialObjectPoint
+.. [TODO: This will need to be uncommented once PR #186 is merged and the official documentation is updated
+.. [breathelink:: itk::LineSpatialObject
+.. [breathelink:: itk::LineSpatialObjectPoint
diff --git a/src/Core/SpatialObjects/LineSpatialObject/line.png.sha512 b/src/Core/SpatialObjects/LineSpatialObject/line.png.sha512
diff --git a/src/Core/SpatialObjects/index.rst b/src/Core/SpatialObjects/index.rst
@@ -8,4 +8,4 @@ SpatialObjects
   ContourSpatialObject/Documentation.rst
   ConvertSpatialObjectToImage/Documentation.rst
   Ellipse/Documentation.rst
-  LineSpatialObject2/Documentation.rst
+  LineSpatialObject/Documentation.rst

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,8 @@ compare_to_baseline(EXAMPLE_NAME Ellipse`
`8`	`8`	`BASELINE_PREFIX EllipseOutput`
`9`	`9`	`)`
`10`	`10`
`11`		`-add_example(LineSpatialObject2)`
`12`		`-compare_to_baseline(EXAMPLE_NAME LineSpatialObject2`
	`11`	`+add_example(LineSpatialObject)`
	`12`	`+compare_to_baseline(EXAMPLE_NAME LineSpatialObject`
`13`	`13`	`BASELINE_PREFIX line`
`14`	`14`	`)`
`15`	`15`