Build doxygen documentation by cmake (#17)

* added cmake command to make doxygen docs

* added back doxyfile for users

CMakeLists.txt

@@ -169,7 +169,29 @@ if (SLS_USE_PYTHON)
 endif(SLS_USE_PYTHON)
 
 configure_file( .clang-tidy  
-    ${CMAKE_BINARY_DIR}/.clang-tidy  )
+    ${CMAKE_BINARY_DIR}/.clang-tidy  
+)
+
+
+if (DOXYGEN_FOUND)
+    # set input and output files
+    set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/doxygen/Doxyfile.in)
+    set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+
+    # request to configure the file
+    configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+    message("Doxygen build started")
+
+    # note the option ALL which allows to build the docs together with the application
+    add_custom_target( docs
+        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        COMMENT "Generating API documentation with Doxygen"
+        VERBATIM )
+else (DOXYGEN_FOUND)
+  message("Doxygen need to be installed to generate the doxygen documentation")
+endif (DOXYGEN_FOUND)
+
 
 if(SLS_MASTER_PROJECT)
     # Set install dir CMake packages

slsDetectorSoftware/CMakeLists.txt

@@ -124,14 +124,14 @@ endif()
 install(TARGETS sls_detector_put sls_detector_get sls_detector_acquire sls_detector_help DESTINATION bin)
 
 
-if(DOXYGEN_FOUND)
+# if(DOXYGEN_FOUND)
-    add_custom_target(doc
+#     add_custom_target(doc
-        ${DOXYGEN_EXECUTABLE}
+#         ${DOXYGEN_EXECUTABLE}
-        ${CMAKE_CURRENT_SOURCE_DIR}/slsDetectorUsers.doxy
+#         ${CMAKE_CURRENT_SOURCE_DIR}/slsDetectorUsers.doxy
-        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+#         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        COMMENT "Generating API documentation with Doxygen" VERBATIM
+#         COMMENT "Generating API documentation with Doxygen" VERBATIM
-    )
+#     )
-endif()
+# endif()
 
 if (SLS_USE_TESTS)
     add_subdirectory(tests)

slsDetectorSoftware/include/slsDetectorUsers.h

@@ -24,12 +24,12 @@ class detectorData;
 
 
 /*
-   \mainpage 
 <CENTER><H1>API for SLS detectors data acquisition</H1></CENTER>
 <HR>
  */
 /** 
-    \mainpage 
+\mainpage 
+\subpage CLI
 
 
 <H1>API for SLS detectors data acquisition</H1>

slsDetectorSoftware/src/slsDetectorCommand.cpp

@@ -10,7 +10,8 @@
 #include <iomanip>
 
 
-/*! \mainpage Introduction
+/*! \page CLI Command line interface
+
 
 This program is intended to control the SLS detectors via command line interface.
 This is the only way to access all possible functionality of the detectors, however it is often recommendable to avoid changing the most advanced settings, rather leaving the task to configuration files, as when using the GUI or the API provided.
@@ -55,16 +56,16 @@ the same multi detector id for both detectors as they have a different shared me
 For additional questions concerning the indexing of the detector, please refer to the SLS Detectors FAQ documentation.
 
 The commands are sudivided into different pages depending on their functionalities:
- - \ref acquisition "Acquisition": commands to start/stop the acquisition and retrieve data
+ - \subpage acquisition "Acquisition": commands to start/stop the acquisition and retrieve data
- - \ref config "Configuration": commands to configure the detector
+ - \subpage config "Configuration": commands to configure the detector
- - \ref timing "Timing": commands to configure the detector timing
+ - \subpage timing "Timing": commands to configure the detector timing
- - \ref data "Data postprocessing": commands to process the data
+ - \subpage data "Data postprocessing": commands to process the data
- - \ref settings "Settings": commands to define detector settings/threshold.
+ - \subpage settings "Settings": commands to define detector settings/threshold.
- - \ref output "Output": commands to define output file destination and format
+ - \subpage output "Output": commands to define output file destination and format
- - \ref network "Network": commands to setup the network between client, detector and receiver
+ - \subpage network "Network": commands to setup the network between client, detector and receiver
- - \ref receiver "Receiver": commands to configure the receiver
+ - \subpage receiver "Receiver": commands to configure the receiver
- - \ref prototype "Chip Test Board / Moench": commands specific for the chiptest board or moench
+ - \subpage prototype "Chip Test Board / Moench": commands specific for the chiptest board or moench
- - \ref test "Developer": commands to be used only for software debugging. Avoid using them!
+ - \subpage test "Developer": commands to be used only for software debugging. Avoid using them!
  
  */
 
@@ -2138,11 +2139,6 @@ std::string slsDetectorCommand::executeLine(int narg, char *args[], int action,
     return cmdUnknown(narg, args, action, detPos);
 }
 
-/*! \page advanced Advanced Usage
-This page is for advanced users.
-Make sure you have first read \ref intro "the introduction".
- */
-
 std::string slsDetectorCommand::cmdUnknown(int narg, char *args[], int action, int detPos) {
     return std::string("Unknown command ") + std::string(args[0]) + std::string("\n") + helpLine(0, args, action, detPos);
 }