BasicVector3D.h: sort file and class comments

Base/Vector/BasicVector3D.h

@@ -9,16 +9,16 @@
 //! @license   GNU General Public License v3 or higher (see COPYING)
 //! @copyright Forschungszentrum Jülich GmbH 2018
 //! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
+//!
+//! Forked from CLHEP/Geometry by E. Chernyaev <Evgueni.Tcherniaev@cern.ch>,
+//! then reworked beyond recognition. Removed split of point and vector semantics.
+//! Transforms are relegated to a separate class Transform3D.
 //
 //  ************************************************************************************************
 
 #ifndef BORNAGAIN_BASE_VECTOR_BASICVECTOR3D_H
 #define BORNAGAIN_BASE_VECTOR_BASICVECTOR3D_H
 
-//! Forked from CLHEP/Geometry by E. Chernyaev <Evgueni.Tcherniaev@cern.ch>,
-//! then reworked beyond recognition. Removed split of point and vector semantics.
-//! Transforms are relegated to a separate class Transform3D.
-
 #include <complex>
 
 //! Three-dimensional vector template, for use with integer, double, or complex components.

CMakeLists.txt

@@ -72,9 +72,10 @@ endif()
 ## Various CMake settings (include order is of critical importance)
 
 # function definitions
-include(commons/GetFilenameComponent) # overwrite CMake command
-include(BornAgain/SwigLib)
-include(BornAgain/MakeLib)
+include(commons/GetFilenameComponent) # fct get_filename_component (overwrites CMake's built-in)
+include(BornAgain/PythonDocs) # fct GeneratePythonDocs
+include(BornAgain/SwigLib) # fct SwigLib
+include(BornAgain/MakeLib) # fct MakeLib
 
 # main settings
 
@@ -104,7 +105,6 @@ include(BornAgain/Config)
 if(BORNAGAIN_PYTHON)
     include(BornAgain/PythonAPI)
 endif()
-include(BornAgain/PythonDocs)
 
 # debug optimization
 if(BORNAGAIN_DEBUG_OPTIMIZATION)

cmake/BornAgain/PythonDocs.cmake

 # Autogenerate a .i file from doxygen comments, provided -DCONFIGURE_PYTHON_DOCS=ON.
+# Called from function SwigLib.
 
 function(GeneratePythonDocs PD_TARGET SWIG_DIR)
     if(CONFIGURE_PYTHON_DOCS)

cmake/BornAgain/SwigLib.cmake

@@ -13,8 +13,7 @@ function(SwigLib name lib TMP_DIR)
 
         file(MAKE_DIRECTORY ${TMP_DIR})
 
-        GeneratePythonDocs(${AUTO_DIR}/doxygen${name}.i ${SWIG_DIR})
-
+        # static (manually written) input files
         set(swig_dependencies
             ${SWIG_DIR}/lib${lib}.i
             ${SWIG_DIR}/deprecation.i
@@ -27,6 +26,9 @@ function(SwigLib name lib TMP_DIR)
                 message(FATAL_ERROR "Could NOT find SWIG input ${FNAM}")
             endif()
         endforeach()
+
+        # dynamic (autogenerated) input files
+        GeneratePythonDocs(${AUTO_DIR}/doxygen${name}.i ${SWIG_DIR})
         list(APPEND swig_dependencies ${AUTO_DIR}/doxygen${name}.i)
 
         # Run Swig.