cmake: Restore and flesh out comments.

Author: Matthew Emmett

CMakeLists.txt

@@ -5,13 +5,16 @@ list(APPEND CMAKE_MODULE_PATH ${pfasst_SOURCE_DIR}/cmake)
 include(cmake/utility_functions.cmake)
 include(CheckCXXCompilerFlag)
 include(ExternalProject)
+
+# Set default ExternalProject root directory
 set_directory_properties(PROPERTIES EP_PREFIX ${CMAKE_BINARY_DIR}/3rdparty)
 
 option(pfasst_DISABLE_LIBCXX "Disable use of LLVM's libc++ when compiling with Clang." ON )
 option(pfasst_BUILD_EXAMPLES "Build example programs."                                 ON )
 option(pfasst_BUILD_TESTS    "Build test suite for PFASST."                            ON )
 option(pfasst_WITH_MPI       "Build with MPI enabled."                                 OFF)
 
+# Set output directories
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${pfasst_SOURCE_DIR}/dist/bin")
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${pfasst_SOURCE_DIR}/dist/lib")
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${pfasst_SOURCE_DIR}/dist/lib")
@@ -59,6 +62,7 @@ else()
 endif()
 message(STATUS "Your compiler has C++11 support. Hurray!")
 
+# Enable all compiler warnings
 add_to_string_list("${CMAKE_CXX_FLAGS}" CMAKE_CXX_FLAGS "-Wall -Wextra -Wpedantic")
 
 set(3rdparty_INCLUDES)
@@ -70,8 +74,14 @@ if(pfasst_BUILD_TESTS)
     enable_testing()
 endif(pfasst_BUILD_TESTS)
 
+# Add / include 3rd-party libraries
 message(STATUS "********************************************************************************")
 message(STATUS "Configuring 3rd party libraries")
+# makes available:
+#  - Boost headers in 3rdparty_INCLUDES
+#  - Google test and mock headers in 3rdparty_INCLUDES (if pfasst_BUILD_TESTS)
+#  - FFTW_INCLUDE_PATH (if pfasst_BUILD_EXAMPLES)
+#  - FFTW_LIBRARIES (if pfasst_BUILD_EXAMPLES)
 add_subdirectory(3rdparty)
 
 message(STATUS "********************************************************************************")