added doxygen output

CMakeLists.txt

@@ -2,10 +2,16 @@ cmake_minimum_required (VERSION 3.4.3)
 
 set (CMAKE_CXX_STANDARD 14)
 
-project (CORSIKA VERSION 8.0.0.0 DESCRIPTION "CORSIKA C++ project")
+project (corsika VERSION 8.0.0 DESCRIPTION "CORSIKA C++ project")
+
+#add_custom_target (corsika_pre_build)
+#add_custom_command (TARGET corsika_pre_build PRE_BUILD COMMAND "${PROJECT_SOURCE_DIR}/pre_compile.py")
 
 find_package (Boost 1.40 COMPONENTS program_options REQUIRED)
 find_package (Eigen3 3.3 REQUIRED)
 
+add_subdirectory (Documentation)
 add_subdirectory (Framework)
+#add_subdirectory (Processes)
 add_subdirectory (Main)
+

Documentation/CMakeLists.txt

+
+add_subdirectory (Doxygen)
+add_subdirectory (Examples)
+

Documentation/Doxygen/CMakeLists.txt

+
+find_package (Doxygen REQUIRED dot OPTIONAL_COMPONENTS mscgen dia)
+
+if (DOXYGEN_FOUND)
+  set (DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
+  set (DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+  set (DOXYGEN_GENERATE_HTML YES)
+  set (DOXYGEN_GENERATE_MAN YES)
+  configure_file (${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+  message ("Start doxygen with \"make doxygen\"")
+  
+  # note the option ALL which allows to build the docs together with the application
+  add_custom_target (doxygen # ALL
+    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Generating API documentation with Doxygen"
+    VERBATIM)
+
+  install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION share/doc OPTIONAL)
+         
+else (DOXYGEN_FOUND)
+  
+  message ("Doxygen need to be installed to generate the doxygen documentation")
+  
+endif (DOXYGEN_FOUND)
+

Documentation/Doxygen/Doxyfile.in

+PROJECT_NAME           = CORSIKA8
+
+OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../.. 
+
+GENERATE_HTML          = YES
+GENERATE_LATEX         = NO
+
+FILE_PATTERNS          = *.cc *.h
+RECURSIVE              = YES
+
+SOURCE_BROWSER         = YES
+# INLINE_SOURCES
+
+CLASS_DIAGRAMS         = YES
+HAVE_DOT               = YES
+CLASS_GRAPH            = YES
+UML_LOOK               = YES
+TEMPLATE_RELATIONS     = YES
+INCLUDE_GRAPH          = YES
+GRAPHICAL_HIERARCHY    = YES
+DIRECTORY_GRAPH        = YES
+GENERATE_LEGEND        = YES
+
+SEARCHENGINE           = YES

Documentation/Examples/CMakeLists.txt

+
+
+add_executable (geometry_example geometry_example.cc)
+target_link_libraries (geometry_example CORSIKAgeometry CORSIKAunits)
+install (TARGETS geometry_example DESTINATION share/examples)
+
+
+add_executable (logger_example logger_example.cc)
+target_link_libraries (logger_example CORSIKAunits CORSIKAlogging)
+install (TARGETS logger_example DESTINATION share/examples)

Main/geometry_example.cc → Documentation/Examples/geometry_example.cc

@@ -28,14 +28,14 @@ int main()
     auto const diff = p2 - p1;
     auto const norm = diff.squaredNorm();
     
-    std::cout << diff.getComponents() << std::endl;
-    std::cout << norm << std::endl;
+    std::cout << "p2-p1 components: " << diff.getComponents() << std::endl;
+    std::cout << "p2-p1 norm^2: " << norm << std::endl;
     
     Sphere s(p1, 10_m);
-    std::cout << s.isInside(p2) << std::endl;    
+    std::cout << "p1 inside s:  " << s.isInside(p2) << std::endl;    
     
     Sphere s2(p1, 3_um);
-    std::cout << s2.isInside(p2) << std::endl;    
+    std::cout << "p1 inside s2: " << s2.isInside(p2) << std::endl;    
     
     return EXIT_SUCCESS;
 }

Main/logger_example.cc → Documentation/Examples/logger_example.cc

@@ -11,6 +11,7 @@ int
 main()
 {
   {
+    cout << "writing to \"another.log\"" << endl;
     ofstream logfile("another.log");
     typedef Sink<ofstream, StdBuffer> SinkFile;
     SinkFile sink(logfile, StdBuffer(10000));

Main/CMakeLists.txt

 
 
-add_executable (geometry_example geometry_example.cc)
-target_link_libraries (geometry_example CORSIKAgeometry CORSIKAunits)
-install (TARGETS geometry_example DESTINATION bin)
-
-
-add_executable (logger_example logger_example.cc)
-target_link_libraries (logger_example CORSIKAunits CORSIKAlogging)
-install (TARGETS logger_example DESTINATION bin)

Processes/CMakeLists.txt

+add_subdirectory (NullModel)