Modified documentation

Author: tsing

CMakeLists.txt

@@ -22,6 +22,10 @@ endif()
 cmake_minimum_required(VERSION 3.1)
 set( CMAKE_EXPORT_COMPILE_COMMANDS 1 )
 project( SLS )
+set (VERSION_MAJOR 4)
+set (VERSION_MINOR 0)
+set (VERSION_PATCH 1)
+
 
 # Include this project
 include_directories(./src/lib)
@@ -83,6 +87,7 @@ option (COVERAGE "Build with coverage test, require GTEST=on" OFF)
 if (COVERAGE AND GTEST)
     set (CMAKE_CXX_FLAGS "-std=c++11 -g -O0 -fprofile-arcs -ftest-coverage")
     set (CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
+    set(CMAKE_EXE_LINKER_FLAGS="-fprofile-arcs -ftest-coverage")
 endif()
 
 # Enable documentation

README.md

@@ -40,6 +40,12 @@ make test
 ```
 Google test will be downloaded and compiled during the compilation stage. 
 
+### Build documentation
+Document with Doxygen is availabe to be built. Use `-DBUILD_DOC=on` cmake flag to enable documentation. Run `make doc`, the documentation will be generated in the `doc` directory of building path. 
+
+### Code coverage
+Code coverage report is provided by using [lcov](http://ltp.sourceforge.net/coverage/lcov.php). In order to get the code coverage report, enable both test and coverage flag: `-DGTEST=on -DCOVERAGE=on` and run `make coverage`. The coverage report will be generated in the `coverage` directory of building path. 
+
 ### Run demo binary
 ```
 usage: ./SLS --leftcam=string --rightcam=string --leftconfig=string --rightconfig=string --output=string --format=string --width=unsigned long --height=unsigned long [options] ... 
@@ -62,66 +68,8 @@ Most of the outputs are written to the log file named `SLS.log`. To track the ou
 
 ### Use the library
 
-This project also provides libraries that can be easily integrated into other projects. Here's a quick start code for using the libraries.
-
-```C++
-#ifdef CPU
-
-/* Using CPU reconstruction */
-#include <core/fileReader.h>
-#include <core/Reconstructor.h>
-#else
-
-/* Using CUDA reconstruction */
-#include <ReconstructorCUDA/fileReaderCUDA.cuh>
-#include <ReconstructorCUDA/ReconstructorCUDA.cuh>
-#endif
-
-
-int main()
-{
-    // Folders contain reconstruction images
-    std::string rightCameraFolder = "../../data/alexander/rightCam/dataset1/"
-    std::string leftCameraFolder = "../../data/alexander/leftCam/dataset1/"
-
-    // Camera configuration files
-    std::string rightConfigFile = "../../data/alexander/rightCam/calib/output/calib.xml"
-    std::string leftConfigFile = "../../data/alexander/leftCam/calib/output/calib.xml"
-
-#ifdef CPU
-    SLS::FileReader rightCam("rightCamera");
-    SLS::FileReader leftCam("leftCamera");
-#else
-    SLS::FileReaderCUDA rightCam("rightCamera");
-    SLS::FileReaderCUDA leftCam("leftCamera");
-#endif
-
-    // Load image from data folder
-    rightCam.loadImages(rightCameraFolder);
-    leftCam.loadImages(leftCameraFolder);
-
-    // Load configuration files
-    rightCam.loadConfig(rightConfigFile);
-    leftCam.loadConfig(leftConfigFile);
-
-    // Initialize a reconstructor the projector resolution. 
-#ifdef CPU
-    SLS::ReconstructorCPU reconstructor(1024,768);
-#else
-    SLS::ReconstructorCUDA reconstructor(1024,768);
-#endif
-    // Pass cameras to the reconstructor.
-    reconstructor.addCamera(&rightCam);
-    reconstructor.addCamera(&leftCam);
-
-    // Reconstructor returns a point cloud
-    auto pointCloud = reconstructor.reconstruct();
-
-    // Export point cloud to file.
-    pointCloud.exportPointCloud("alexander.ply", "ply");
-    return 0;
-}
-```
+This project also provides libraries that can be easily integrated into other projects. Here's a quick start code for using the libraries. An example of [CPU](https://github.com/theICTlab/3DUNDERWORLD-SLS-GPU_CPU/blob/dev/src/app/App.cpp) and [GPU](https://github.com/theICTlab/3DUNDERWORLD-SLS-GPU_CPU/blob/dev/src/app/App_CUDA.cu) applications are included in the repository. 
+
 
 ## Known issues
 
@@ -174,4 +122,3 @@ Immersive and Creative Technologies Lab (http://www.theICTlab.org), Concordia Un
   bibsource = {dblp computer science bibliography, http://dblp.org}
 }
 ```
-

doc/CMakeLists.txt

@@ -1,3 +1,14 @@
 find_package(Doxygen REQUIRED)
-message(STATUS ${DOXYGEN_EXECUTABLE})
+
+set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/doxygen.in)
+set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/doxyfile)
+set(doxy_main_page ${CMAKE_SOURCE_DIR}/README.md)
+
+configure_file(${doxyfile_in} ${doxyfile} @ONLY)
+
+add_custom_target(doc
+    COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Generating API documentation with Doxygen"
+    VERBATIM)
 

doc/doxygen.in

@@ -1,12 +1,19 @@
 PROJECT_NAME           = "@CMAKE_PROJECT_NAME@"
 PROJECT_NUMBER         = @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@
-STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@ \
-                         @PROJECT_BINARY_DIR@
+STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@/src/lib
 INPUT                  = @doxy_main_page@ \
-                         @PROJECT_SOURCE_DIR@ \
-                         @PROJECT_BINARY_DIR@
+                         @PROJECT_SOURCE_DIR@/src/lib
+
+EXTRACT_ALL            = YES
+EXTENSION_MAPPING      = cu=c++ \
+                         cuh=c++
 FILE_PATTERNS          = *.h \
-                         *.cc
+                         *.cc \
+                         *.hpp \
+                         *.cpp \
+                         *.cu \
+                         *.cuh
+
 RECURSIVE              = YES
 USE_MDFILE_AS_MAINPAGE = @doxy_main_page@
 

test/CMakeLists.txt

@@ -29,7 +29,10 @@ target_link_libraries(runCPUTest core)
 # Use test 
 if (COVERAGE)
     include(CodeCoverage)
-    setup_target_for_coverage(${PROJECT_NAME}_coverage runCPUTest coverage)
+    if(CMAKE_COMPILER_IS_GNUCXX)
+        target_link_libraries(runCPUTest gcov)
+    endif()
+    setup_target_for_coverage(coverage runCPUTest coverage)
 endif(COVERAGE)
 
 add_test( NAME CPU_TEST