[mlpack-git] master: Update Doxyfile generation and list of trees. (36324dc)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/c49adeab929c536f8ad7497567fd4603e9ff5905...36324dc2dc6818ec30de8c20c2a5644d316c2aaa

>---------------------------------------------------------------

commit 36324dc2dc6818ec30de8c20c2a5644d316c2aaa
Author: Ryan Curtin <ryan at ratml.org>
Date:   Mon Aug 3 13:02:15 2015 -0400

    Update Doxyfile generation and list of trees.


>---------------------------------------------------------------

36324dc2dc6818ec30de8c20c2a5644d316c2aaa
 CMake/GenerateDoxyfile.cmake |  9 +++++++--
 doc/policies/trees.hpp       | 18 +++++++++++++++++-
 2 files changed, 24 insertions(+), 3 deletions(-)

diff --git a/CMake/GenerateDoxyfile.cmake b/CMake/GenerateDoxyfile.cmake
index da37beb..de81410 100644
--- a/CMake/GenerateDoxyfile.cmake
+++ b/CMake/GenerateDoxyfile.cmake
@@ -25,12 +25,17 @@ string(REPLACE
     DOXYFILE_AUXVAR "${DOXYFILE_CONTENTS}"
 )
 
+string(REPLACE
+    "./doc/policies"
+    "${CMAKE_CURRENT_SOURCE_DIR}/doc/policies"
+    DOXYFILE_CONTENTS "${DOXYFILE_AUXVAR}")
+
 # Change the STRIP_FROM_PATH so that it works right even in the build directory;
 # otherwise, every file will have the full path in it.
 string(REGEX REPLACE
     "(STRIP_FROM_PATH[ ]*=) ./"
     "\\1 ${CMAKE_CURRENT_SOURCE_DIR}/"
-    DOXYFILE_CONTENTS ${DOXYFILE_AUXVAR})
+    DOXYFILE_AUXVAR ${DOXYFILE_CONTENTS})
 
 # Save the Doxyfile to its new location.
-file(WRITE "${DESTDIR}/Doxyfile" "${DOXYFILE_CONTENTS}")
+file(WRITE "${DESTDIR}/Doxyfile" "${DOXYFILE_AUXVAR}")
diff --git a/doc/policies/trees.hpp b/doc/policies/trees.hpp
index 0b52f71..ebcfbd2 100644
--- a/doc/policies/trees.hpp
+++ b/doc/policies/trees.hpp
@@ -805,6 +805,22 @@ handle memory management!
 
 @section treetype_more A list of trees in mlpack and more information
 
-
+mlpack contains several ready-to-use implementations of trees that satisfy the
+TreeType policy API:
+
+ - mlpack::tree::KDTree
+ - mlpack::tree::MeanSplitKDTree
+ - mlpack::tree::BallTree
+ - mlpack::tree::MeanSplitBallTree
+ - mlpack::tree::RTree
+ - mlpack::tree::RStarTree
+ - mlpack::tree::StandardCoverTree
+
+Often, these are template typedefs of more flexible tree classes:
+
+ - mlpack::tree::BinarySpaceTree -- binary trees, such as the KD-tree and ball
+   tree
+ - mlpack::tree::RectangleTree -- the R tree and variants
+ - mlpack::tree::CoverTree -- the cover tree and variants
 
 */