[mlpack-svn] [MLPACK] #187: Integrate CMake and Doxygen a little better

[MLPACK Trac]

#187: Integrate CMake and Doxygen a little better
--------------------------+-------------------------------------------------
 Reporter:  rcurtin       |        Owner:  rcurtin                               
     Type:  task          |       Status:  new                                   
 Priority:  trivial       |    Milestone:  mlpack 1.1.0                          
Component:  build system  |     Keywords:  doxygen cmake documentation generation
 Blocking:                |   Blocked By:                                        
--------------------------+-------------------------------------------------
 In r11258, I have committed a change which allows one to type 'make doc'
 to generate the documentation.  This command was based on Sterling's link
 to http://majewsky.wordpress.com/2010/08/14/tip-of-the-day-cmake-and-
 doxygen/ .  However, we do not have a Doxyfile.in, which is used to
 prevent CMake from allowing Doxygen to write inside the source tree at
 all.

 The patch which I wrote makes Doxygen generate the documentation into
 ${CMAKE_CURRENT_SOURCE_DIR}/doc and then copies it to
 ${CMAKE_BINARY_DIR}/doc, which is suboptimal.  Perhaps there is a nice way
 to have Doxygen generate the documentation directly into the build
 artifact directory, without needing a Doxyfile.in?  If a Doxyfile.in could
 be avoided, this is good, because users can still check out the code and
 just type 'doxygen' (that is, they don't need CMake to make the
 documentation).

-- 
Ticket URL: <http://trac.research.cc.gatech.edu/fastlab/ticket/187>
MLPACK <www.fast-lab.org>
MLPACK is an intuitive, fast, and scalable C++ machine learning library developed by the FASTLAB at Georgia Tech under Dr. Alex Gray.