Add TODO items to bottom of main README file and update Doxygen output.

README.md

@@ -98,6 +98,13 @@ Once you've made your great commits:
   5. That's it!
 
 Disclaimer
-------
+------------
 
 The copyright holders are not liable for any damage(s) incurred due to improper use of sml.
+
+TODO
+------------
+@todo Find a way to provide an option to clean installation.
+@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.

docs/README_8md.html

@@ -98,7 +98,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="README_8md.html">README.md</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:33 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/basicFunctions_8hpp.html

@@ -124,7 +124,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3d7d0de844b3caea53996c526e8984a.html">sml</a></li><li class="navelem"><a class="el" href="basicFunctions_8hpp.html">basicFunctions.hpp</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:33 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/basicFunctions_8hpp_source.html

@@ -102,7 +102,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3d7d0de844b3caea53996c526e8984a.html">sml</a></li><li class="navelem"><a class="el" href="basicFunctions_8hpp.html">basicFunctions.hpp</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:33 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/constants_8hpp.html

@@ -113,7 +113,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3d7d0de844b3caea53996c526e8984a.html">sml</a></li><li class="navelem"><a class="el" href="constants_8hpp.html">constants.hpp</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:33 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/constants_8hpp_source.html

@@ -98,7 +98,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3d7d0de844b3caea53996c526e8984a.html">sml</a></li><li class="navelem"><a class="el" href="constants_8hpp.html">constants.hpp</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:33 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/dir_b3d7d0de844b3caea53996c526e8984a.html

@@ -108,7 +108,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3d7d0de844b3caea53996c526e8984a.html">sml</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:34 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/dir_d44c64559bbebec7f509842c48db8b23.html

@@ -102,7 +102,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:34 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/files.html

@@ -103,7 +103,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:16 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:34 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/index.html

@@ -90,10 +90,10 @@
 <div class="title">sml </div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p>SML (Simple Mathematics Library) is a C++ (template) library that provides basic mathematics functionality. The library is 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: <a href="https://github.com/openastro/cmake-modules/blob/master/Modules/Findsml.cmake">Findsml.cmake</a>.</p>
+<div class="textblock"><p>sml (simple mathematics library) is a C++ (template) library that provides basic mathematics functionality. The library is 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: <a href="https://github.com/openastro/cmake-modules/blob/master/Modules/Findsml.cmake">Findsml.cmake</a>.</p>
 <h2>Features </h2>
 <ul>
-<li>Header-only</li>
+<li>Header-only, zero-dependency</li>
 <li>Generic linear algebra functions</li>
 <li>Basic constants</li>
 <li>Full suite of tests</li>
@@ -110,7 +110,7 @@ <h2>Requirements </h2>
 </ul>
 <p>The following dependencies are optional (see <code>Build options</code>):</p>
 <ul>
-<li><a href="https://www.github.com/philsquared/Catch">CATCH</a> (unit testing library necessary for <code>BUILD_TESTS</code> build option)</li>
+<li><a href="https://github.com/catchorg/Catch2">Catch2</a> (unit testing library necessary for <code>BUILD_TESTS</code> build option)</li>
 </ul>
 <p>These dependencies will be downloaded and configured automagically if not already present locally (requires an internet connection).</p>
 <h2>Installation </h2>
@@ -139,11 +139,10 @@ <h2>Project structure </h2>
 <p>This project has been set up with a specific file/folder structure in mind. The following describes some important features of this setup:</p>
 <ul>
 <li><code>cmake/Modules</code> : Contains <code>CMake</code> modules, including <code>Findsml.cmake</code> module</li>
-<li><code>docs</code>: Contains project-specific docs in <a href="https://help.github.com/articles/github-flavored-markdown/" title="GitHub Flavored Markdown">Markdown</a> that are also parsed by <a href="http://www.doxygen.org" title="Doxygen homepage">Doxygen</a>. This sub-directory includes <code>global_todo.md</code>, which contains a global list of TODO items for project that appear on TODO list generated in <a href="http://www.doxygen.org" title="Doxygen homepage">Doxygen</a> documentation</li>
-<li><code>doxydocs</code>: HTML output generated by building <a href="http://www.doxygen.org" title="Doxygen homepage">Doxygen</a> documentation</li>
+<li><code>docs</code>: Contains code documentation generated by <a href="http://www.doxygen.org" title="Doxygen homepage">Doxygen</a></li>
 <li><code>include/sml</code>: Project header files (*.hpp)</li>
 <li><code>scripts</code>: Shell scripts used in <a href="https://travis-ci.org/" title="Travis CI homepage">Travis CI</a> build</li>
-<li><code>test</code>: Project test source files (*.cpp) that are provided to the <a href="https://www.github.com/philsquared/Catch" title="Catch Github repository">Catch</a> framework</li>
+<li><code>test</code>: Project test source files (*.cpp) that are provided to the <a href="https://github.com/catchorg/Catch2" title="Catch2 Github repository">Catch2</a> framework</li>
 <li><code>.travis.yml</code>: Configuration file for <a href="https://travis-ci.org/" title="Travis CI homepage">Travis CI</a> build, including static analysis using <a href="https://scan.coverity.com/" title="Coverity Scan homepage">Coverity Scan</a> and code coverage using <a href="https://coveralls.io" title="Coveralls.io homepage">Coveralls</a></li>
 <li><code>CMakeLists.txt</code>: main <code>CMakelists.txt</code> file for project (should not need to be modified for basic build)</li>
 <li><code>Dependencies.cmake</code>: list of dependencies and automated build, triggered if dependency cannot be found locally</li>
@@ -162,13 +161,19 @@ <h2>Contributing </h2>
 <li>That's it!</li>
 </ol>
 <h2>Disclaimer </h2>
-<p>The copyright holders are not liable for any damage(s) incurred due to improper use of sml. </p>
+<p>The copyright holders are not liable for any damage(s) incurred due to improper use of sml.</p>
+<h2>TODO </h2>
+<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd><p class="startdd">Find a way to provide an option to clean installation. </p>
+<p>Find a way to remove workaround to get Doxygen to not throw warnings in readme. </p>
+<p>Find a way to have nested variables in <code>Doxygen</code> config file so that e.g., <code>@@CMAKE_PROJECT_NAME@_VERSION@</code> works. </p>
+<p class="enddd">Add version detection in <code>CMake</code> module so that find_package respects minimum version required. </p>
+</dd></dl>
 </div></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:16 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:34 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/linearAlgebra_8hpp.html

@@ -157,7 +157,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3d7d0de844b3caea53996c526e8984a.html">sml</a></li><li class="navelem"><a class="el" href="linearAlgebra_8hpp.html">linearAlgebra.hpp</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:33 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/linearAlgebra_8hpp_source.html

@@ -107,7 +107,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3d7d0de844b3caea53996c526e8984a.html">sml</a></li><li class="navelem"><a class="el" href="linearAlgebra_8hpp.html">linearAlgebra.hpp</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:33 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/menudata.js

@@ -23,6 +23,7 @@ for the JavaScript code in this file
 */
 var menudata={children:[
 {text:"Main Page",url:"index.html"},
+{text:"Related Pages",url:"pages.html"},
 {text:"Namespaces",url:"namespaces.html",children:[
 {text:"Namespace List",url:"namespaces.html"},
 {text:"Namespace Members",url:"namespacemembers.html",children:[

docs/namespacemembers.html

@@ -135,7 +135,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:16 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:34 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/namespacemembers_func.html

@@ -132,7 +132,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:16 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:34 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/namespacemembers_vars.html

@@ -96,7 +96,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:16 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:34 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/namespaces.html

@@ -100,7 +100,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:16 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:34 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/namespacesml.html

@@ -826,7 +826,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0de6c4d6b9d119a350d84489
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="namespacesml.html">sml</a></li>
-    <li class="footer">Generated on Thu Aug 16 2018 14:20:12 for sml by
+    <li class="footer">Generated on Tue Aug 21 2018 13:44:34 for sml by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
   </ul>

docs/navtreedata.js

@@ -24,6 +24,7 @@ for the JavaScript code in this file
 var NAVTREE =
 [
   [ "sml", "index.html", [
+    [ "Todo List", "todo.html", null ],
     [ "Namespaces", "namespaces.html", [
       [ "Namespace List", "namespaces.html", "namespaces_dup" ],
       [ "Namespace Members", "namespacemembers.html", [

docs/navtreeindex0.js

@@ -1,34 +1,35 @@
 var NAVTREEINDEX0 =
 {
-"basicFunctions_8hpp.html":[1,0,0],
-"basicFunctions_8hpp.html#a93758fc3d553c1d8e18f45ebf61a8afb":[1,0,0,1],
-"basicFunctions_8hpp.html#ab26ceb16aed143c1a37f4acfbcd63de8":[1,0,0,0],
-"basicFunctions_8hpp.html#abf1a4db730c356d33f098cfc8942dc10":[1,0,0,2],
-"basicFunctions_8hpp_source.html":[1,0,0],
-"constants_8hpp.html":[1,0,1],
-"constants_8hpp.html#a0de6c4d6b9d119a350d844894ddfa7de":[1,0,1,0],
-"constants_8hpp_source.html":[1,0,1],
-"files.html":[1,0],
+"basicFunctions_8hpp.html":[2,0,0],
+"basicFunctions_8hpp.html#a93758fc3d553c1d8e18f45ebf61a8afb":[2,0,0,1],
+"basicFunctions_8hpp.html#ab26ceb16aed143c1a37f4acfbcd63de8":[2,0,0,0],
+"basicFunctions_8hpp.html#abf1a4db730c356d33f098cfc8942dc10":[2,0,0,2],
+"basicFunctions_8hpp_source.html":[2,0,0],
+"constants_8hpp.html":[2,0,1],
+"constants_8hpp.html#a0de6c4d6b9d119a350d844894ddfa7de":[2,0,1,0],
+"constants_8hpp_source.html":[2,0,1],
+"files.html":[2,0],
 "index.html":[],
-"linearAlgebra_8hpp.html":[1,0,2],
-"linearAlgebra_8hpp.html#a0d29eea637c69448b58d37c0d2dc161f":[1,0,2,7],
-"linearAlgebra_8hpp.html#a14c071bdaab073455d85aa2da81912e6":[1,0,2,5],
-"linearAlgebra_8hpp.html#a3a54fa364eb56a365bbd9038ef9777e7":[1,0,2,10],
-"linearAlgebra_8hpp.html#a3a6dc4b8154e49f46d7d238ae7cc176d":[1,0,2,0],
-"linearAlgebra_8hpp.html#a3f746e6de53f4b92a9492e275929bdc4":[1,0,2,4],
-"linearAlgebra_8hpp.html#a5850b536b02401e88df84d2501aae619":[1,0,2,6],
-"linearAlgebra_8hpp.html#a7659b3de3779c5245c07db23d83f811c":[1,0,2,9],
-"linearAlgebra_8hpp.html#a805dd265cb260d6066d83553503340df":[1,0,2,2],
-"linearAlgebra_8hpp.html#aca839c7251a7c8ddecbc5106aab72d86":[1,0,2,8],
-"linearAlgebra_8hpp.html#acba5c44ce8f89b22258201262435afdf":[1,0,2,3],
-"linearAlgebra_8hpp.html#ada9f4bff1a65b87090ca1a604b8ea663":[1,0,2,1],
-"linearAlgebra_8hpp_source.html":[1,0,2],
-"namespacemembers.html":[0,1,0],
-"namespacemembers_func.html":[0,1,1],
-"namespacemembers_vars.html":[0,1,2],
-"namespaces.html":[0,0],
-"namespacesml.html":[0,0,0],
+"linearAlgebra_8hpp.html":[2,0,2],
+"linearAlgebra_8hpp.html#a0d29eea637c69448b58d37c0d2dc161f":[2,0,2,7],
+"linearAlgebra_8hpp.html#a14c071bdaab073455d85aa2da81912e6":[2,0,2,5],
+"linearAlgebra_8hpp.html#a3a54fa364eb56a365bbd9038ef9777e7":[2,0,2,10],
+"linearAlgebra_8hpp.html#a3a6dc4b8154e49f46d7d238ae7cc176d":[2,0,2,0],
+"linearAlgebra_8hpp.html#a3f746e6de53f4b92a9492e275929bdc4":[2,0,2,4],
+"linearAlgebra_8hpp.html#a5850b536b02401e88df84d2501aae619":[2,0,2,6],
+"linearAlgebra_8hpp.html#a7659b3de3779c5245c07db23d83f811c":[2,0,2,9],
+"linearAlgebra_8hpp.html#a805dd265cb260d6066d83553503340df":[2,0,2,2],
+"linearAlgebra_8hpp.html#aca839c7251a7c8ddecbc5106aab72d86":[2,0,2,8],
+"linearAlgebra_8hpp.html#acba5c44ce8f89b22258201262435afdf":[2,0,2,3],
+"linearAlgebra_8hpp.html#ada9f4bff1a65b87090ca1a604b8ea663":[2,0,2,1],
+"linearAlgebra_8hpp_source.html":[2,0,2],
+"namespacemembers.html":[1,1,0],
+"namespacemembers_func.html":[1,1,1],
+"namespacemembers_vars.html":[1,1,2],
+"namespaces.html":[1,0],
+"namespacesml.html":[1,0,0],
 "pages.html":[],
-"sml_8hpp.html":[1,0,3],
-"sml_8hpp_source.html":[1,0,3]
+"sml_8hpp.html":[2,0,3],
+"sml_8hpp_source.html":[2,0,3],
+"todo.html":[0]
 };