Create separate ProjectFiles.cmake file for easier management.

Update description in readme, including file/folder structure section.
Update Travis config script to use sudoless container.
Add new bash scripts for CMake and Doxygen installation. Add new script to check Doxygen output in Travis script.

Author: kartikkumar

.gitignore

@@ -31,7 +31,7 @@
 build
 bin
 lib
-doxygen-docs
+doxydocs
 temp
 debug
 external

.travis.yml

@@ -4,6 +4,8 @@
 
 language: cpp
 
+sudo: false
+
 compiler:
   - gcc
   - clang
@@ -32,31 +34,28 @@ addons:
     branch_pattern: coverity_scan
 
 before_install:
-  - sudo chmod ugo+x scripts/update_doxygen.sh
-  - sudo chmod ugo+x scripts/check_doxygen_output.sh
-    # Fetch a newer CMake.
-    # https://github.com/bjz/glfw-rs/commit/e9353a14afa5c647497837e16fd44d0e1d6eb326
-  - yes | sudo add-apt-repository ppa:kalakris/cmake
-
-install:
-  - sudo apt-get install cmake
-  - sudo apt-get autoremove
-  - sudo ./scripts/update_doxygen.sh
+  - bash scripts/install_cmake.sh
+  - bash scripts/install_doxygen.sh
+  - chmod ugo+x scripts/check_doxygen.sh
   - if [ "$COVERITY_SCAN_BRANCH_PATTERN" != "coverity_scan" ] && [ "$CXX" == "g++" ] && [ "$BUILD_TYPE" == "Debug" ]; then
-      sudo pip install cpp-coveralls;
+      pip install --user cpp-coveralls;
     fi
 
+before_script::
+  - ls -R $HOME/cmake
+  - ls -R $HOME/doxygen
+
 script:
   - if [ "$COVERITY_SCAN_BRANCH_PATTERN" != "coverity_scan" ]; then
       mkdir build;
       cd build;
-      cmake -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DBUILD_TESTS=on -DBUILD_TESTS_WITH_EIGEN=on  -DBUILD_DOXYGEN_DOCS=on ..;
+      $HOME/cmake/bin/cmake cmake -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DBUILD_TESTS=on -DBUILD_TESTS_WITH_EIGEN=on -DDOXYGEN_EXECUTABLE=$HOME/doxygen/bin/doxygen -DBUILD_DOXYGEN_DOCS=on ..;
       make;
-      ../scripts/check_doxygen_output.sh;
       ctest -V;
+      ../scripts/check_doxygen.sh;
     fi
 
 after_success:
   - if [ "$COVERITY_SCAN_BRANCH_PATTERN" != "coverity_scan" ] && [ "$CXX" == "g++" ] && [ "$BUILD_TYPE" == "Debug" ]; then
-      coveralls --root .. -E ".*external.*" -E ".*CMakeFiles.*" -E ".*test/.*.cpp.*";
-    fi
+      coveralls --root .. -E ".*external.*" -E ".*CMakeFiles.*" -E ".*test/.*.cpp.*" -E ".*src/main.cpp.*";
+    fi

CMakeLists.txt

@@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 2.6)
 
 # Change this section to correspond with your project info.
 project(SML C CXX)
-set(PROJECT_SUMMARY                            "A simple mathematics library")
+set(${CMAKE_PROJECT_NAME}_SUMMARY              "A simple mathematics library")
 set(${CMAKE_PROJECT_NAME}_VENDOR_NAME          "Kartik Kumar")
 set(${CMAKE_PROJECT_NAME}_VENDOR_CONTACT       "[email protected]")
 set(${CMAKE_PROJECT_NAME}_VERSION_MAJOR        0)
@@ -23,15 +23,15 @@ if(NOT EXTERNAL_PATH)
   set(EXTERNAL_PATH                            "${PROJECT_PATH}/external")
 endif(NOT EXTERNAL_PATH)
 if(NOT DOXYGEN_PATH)
-  set(DOXYGEN_PATH                             "${PROJECT_PATH}/doxygen-docs")
+  set(DOXYGEN_PATH                             "${PROJECT_PATH}/doxydocs")
 endif(NOT DOXYGEN_PATH)
 if(NOT DOCS_PATH)
   set(DOCS_PATH                                "${PROJECT_PATH}/docs")
 endif(NOT DOCS_PATH)
 set(TEST_PATH                                  "${PROJECT_BINARY_DIR}/test")
-set(TEST_NAME                                  "test_sml")
+set(TEST_NAME                                  "test_${CMAKE_PROJECT_NAME}")
 
-OPTION(BUILD_DOXYGEN_DOCS                      "Build Doxygen docs"             OFF)
+OPTION(BUILD_DOXYGEN_DOCS                      "Build docs"                     OFF)
 OPTION(BUILD_TESTS                             "Build tests"                    OFF)
 OPTION(BUILD_DEPENDENCIES                      "Force build of dependencies"    OFF)
 
@@ -41,12 +41,7 @@ CMAKE_DEPENDENT_OPTION(BUILD_TESTS_WITH_EIGEN  "Build tests with Eigen library"
 CMAKE_DEPENDENT_OPTION(BUILD_COVERAGE_ANALYSIS "Build code coverage analysis"   OFF
                                                "BUILD_TESTS"                    OFF)
 
-set(TEST_SRC
-  "${TEST_SRC_PATH}/testSml.cpp"
-  "${TEST_SRC_PATH}/testBasicFunctions.cpp"
-  "${TEST_SRC_PATH}/testConstants.cpp"
-  "${TEST_SRC_PATH}/testLinearAlgebra.cpp"
-)
+include(ProjectFiles.cmake)
 
 # Set CMake build-type. If it not supplied by the user, the default built type is "Release".
 if(((NOT CMAKE_BUILD_TYPE)

Doxyfile.in

@@ -1,4 +1,4 @@
-# Doxyfile 1.8.10
+# Doxyfile 1.8.11
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@@ -741,6 +741,12 @@ WARN_IF_DOC_ERROR      = YES
 
 WARN_NO_PARAMDOC       = YES
 
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR          = NO
+
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which
 # will be replaced by the file and line number from which the warning originated
@@ -791,8 +797,8 @@ INPUT_ENCODING         = UTF-8
 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
-# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd,
-# *.vhdl, *.ucf, *.qsf, *.as and *.js.
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
+# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
 
 FILE_PATTERNS          = *.hpp \
                          *.cpp \
@@ -883,6 +889,10 @@ IMAGE_PATH             =
 # Note that the filter must not add or remove lines; it is applied before the
 # code is scanned, but not when the output code is generated. If lines are added
 # or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
 
 INPUT_FILTER           =
 
@@ -892,6 +902,10 @@ INPUT_FILTER           =
 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
 # patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
 
 FILTER_PATTERNS        =
 
@@ -1734,6 +1748,14 @@ LATEX_SOURCE_CODE      = NO
 
 LATEX_BIB_STYLE        = plain
 
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP        = NO
+
 #---------------------------------------------------------------------------
 # Configuration options related to the RTF output
 #---------------------------------------------------------------------------

ProjectFiles.cmake

@@ -0,0 +1,11 @@
+# Copyright (c) 2014-2016 Kartik Kumar, Dinamica Srl ([email protected])
+# Distributed under the MIT License.
+# See accompanying file LICENSE.md or copy at http://opensource.org/licenses/MIT
+
+# Set project test source files.
+set(TEST_SRC
+  "${TEST_SRC_PATH}/testSml.cpp"
+  "${TEST_SRC_PATH}/testBasicFunctions.cpp"
+  "${TEST_SRC_PATH}/testConstants.cpp"
+  "${TEST_SRC_PATH}/testLinearAlgebra.cpp"
+)

README.md

@@ -1,9 +1,9 @@
 SML
 ===
 
-[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/astropnp/sml.svg?branch=master)](https://travis-ci.org/astropnp/sml) [![Coverity Scan Build Status](https://scan.coverity.com/projects/3666/badge.svg)](https://scan.coverity.com/projects/3666) [![Coverage Status](https://coveralls.io/repos/astropnp/sml/badge.png)](https://coveralls.io/r/astropnp/sml)
+\cond [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/astropnp/sml.svg?branch=master)](https://travis-ci.org/astropnp/sml) [![Coverity Scan Build Status](https://scan.coverity.com/projects/3666/badge.svg)](https://scan.coverity.com/projects/3666) [![Coverage Status](https://coveralls.io/repos/astropnp/sml/badge.png)](https://coveralls.io/r/astropnp/sml) \endcond
 
-SML (Simple Mathematics Library) is a C++ (template) library that provides basic mathematics functionality. It's intended to be lightweight and simple to use in other projects. A CMake module is available to make it easy to include SML in other CMake-based projects: [FindSML.cmake](https://github.com/astropnp/cmake-modules/Modules/FindSML.cmake).
+`SML` (Simple Mathematics Library) is a C++ (template) library that provides basic mathematics functionality. The library intended to be lightweight and simple to use in other projects. A CMake module is available to make it easy to include `SML` in other CMake-based projects: [FindSML.cmake](https://github.com/astropnp/cmake-modules/Modules/FindSML.cmake).
 
 Features
 ------
@@ -25,7 +25,7 @@ To install this project, please ensure that you have installed the following (in
   - [Gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) (optional)
   - [LCOV](http://ltp.sourceforge.net/coverage/lcov.php) (optional)
 
-SML does not depend on any libraries. The following libraries are optional (see `Build options`):
+`SML` does not depend on any libraries. The following libraries are optional (see `Build options`):
 
   - [CATCH](https://www.github.com/philsquared/Catch) (unit testing library necessary for `BUILD_TESTS` option)
   - [Eigen](http://eigen.tuxfamily.org/) (linear algebra library necessary for `BUILD_TESTS_WITH_EIGEN` option)
@@ -66,12 +66,31 @@ The following commands are conditional and can only be set if `BUILD_TESTS = ON`
 
 Pass these options either directly to the `cmake ..` build command or run `ccmake ..` instead to bring up the interface that can be used to toggle options.
 
+Project structure
+-------------
+
+This project has been set up with a specific file/folder structure in mind. The following describes some important features of this setup:
+
+  - `cmake/Modules` : Contains `CMake` modules, including `FindCppProject.cmake` template for project-specific module.
+  - `docs`: Contains project-specific docs in [Markdown](https://help.github.com/articles/github-flavored-markdown/ "GitHub Flavored Markdown") that are also parsed by [Doxygen](http://www.doxygen.org "Doxygen homepage"). This sub-directory includes `global_todo.md`, which contains a global list of TODO items for project that appear on TODO list generated in [Doxygen](http://www.doxygen.org "Doxygen homepage") documentation
+  - `doxydocs`: HTML output generated by building [Doxygen](http://www.doxygen.org "Doxygen homepage") documentation
+  - `include/CppProject`: Project header files (*.hpp)
+  - `scripts`: Shell scripts used in [Travis CI](https://travis-ci.org/ "Travis CI homepage") build
+  - `test`: Project test source files (*.cpp), including `testCppProject.cpp`, which contains include for [Catch](https://www.github.com/philsquared/Catch "Catch Github repository")
+  - `.travis.yml`: Configuration file for [Travis CI](https://travis-ci.org/ "Travis CI homepage") build, including static analysis using [Coverity Scan](https://scan.coverity.com/ "Coverity Scan homepage") and code coverage using [Coveralls](https://coveralls.io "Coveralls.io homepage")
+  - `CMakeLists.txt`: main `CMakelists.txt` file for project (should not need to be modified for basic build)
+  - `Dependencies.cmake`: list of dependencies and automated build, triggered if dependency cannot be found locally
+  - `Doxyfile.in`: [Doxygen](http://www.doxygen.org "Doxygen homepage") configuration file, adapted for generic use within project build (should not need to be modified)
+  - `LICENSE.md`: license file for project (copyright statement needs to be edited)
+  - `ProjectFiles.cmake`: list of project source files to build
+  - `README.md`: project readme file, parsed as main page for [Doxygen](http://www.doxygen.org "Doxygen homepage") documentation
+
 Contributing
 ------------
 
 Once you've made your great commits:
 
-  1. [Fork](https://github.com/astropnp/sml/fork) SML
+  1. [Fork](https://github.com/astropnp/sml/fork) `SML`
   2. Create a topic branch - `git checkout -b my_branch`
   3. Push to your branch - `git push origin my_branch`
   4. Create a [Pull Request](http://help.github.com/pull-requests/) from your branch
@@ -80,4 +99,4 @@ Once you've made your great commits:
 Disclaimer
 ------
 
-The copyright holders are not liable for any damage(s) incurred due to improper use of SML.
+The copyright holders are not liable for any damage(s) incurred due to improper use of `SML`.

docs/global_todo.md

@@ -2,6 +2,9 @@ Global Todo
 =======
 
 @todo Find a way to provide an option to clean installation.
-@todo Extend test suite
-@todo Figure out better way (avoiding code duplication) to build STL-based and Eigen-based tests in the same build tree
+@todo Extend test suite.
+@todo Figure out better way (avoiding code duplication) to build STL-based and Eigen-based tests in the same build tree.
 @todo Add version detection in CMake module so that find_package respects minimum version required.
+@todo Find a way to remove \cond \endcond workaround to get Doxygen to not throw warnings in readme.
+@todo Find a way to have nested variables in `Doxygen` config file so that e.g., `@@CMAKE_PROJECT_NAME@_VERSION@` works.
+@todo Add version detection in `CMake` module so that find_package respects minimum version required.

scripts/check_doxygen_output.sh renamed to scripts/check_doxygen.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright (c) 2014-2016 Kartik Kumar, Dinamica Srl ([email protected])
+# Copyright (c) 2014-2016 Kartik Kumar ([email protected])
 # Distributed under the MIT License.
 # See accompanying file LICENSE.md or copy at http://opensource.org/licenses/MIT
 

scripts/install_cmake.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# Copyright (c) 2014-2016 Kartik Kumar ([email protected])
+# Distributed under the MIT License.
+# See accompanying file LICENSE.md or copy at http://opensource.org/licenses/MIT
+
+set -ev
+
+# Fetch and build updated version of CMake from source.
+# Check to see if CMake folder is empty.
+wget https://cmake.org/files/v3.4/cmake-3.4.1-Linux-x86_64.tar.gz --no-check-certificate
+tar -xzvf cmake-3.4.1-Linux-x86_64.tar.gz
+mv cmake-3.4.1-Linux-x86_64 $HOME/cmake

scripts/install_doxygen.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+# Copyright (c) 2014-2016 Kartik Kumar ([email protected])
+# Distributed under the MIT License.
+# See accompanying file LICENSE.md or copy at http://opensource.org/licenses/MIT
+
+set -ev
+
+# Fetch and build updated version of Doxygen from source.
+wget http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.11.linux.bin.tar.gz
+tar -xzvf doxygen-1.8.11.linux.bin.tar.gz
+mv doxygen-1.8.11 $HOME/doxygen