Migration from SVN

mo/doc/CMakeLists.txt

@@ -0,0 +1,37 @@
+######################################################################################
+### 0) Documentation
+######################################################################################
+
+if(DOXYGEN_FOUND)
+    # Directory where the generation will be launched
+    set(MO_DOC_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE PATH "Documentation directory")
+    # Name of the doxygene configuration file
+    set(MO_DOC_CONFIG_FILE "mo.doxyfile" CACHE PATH "Documentation configuration file")
+    if(DOXYGEN_EXECUTABLE)
+        # Creating the custom target
+        if(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
+            add_custom_target(doc-mo
+                COMMAND ${DOXYGEN_EXECUTABLE} ${MO_DOC_CONFIG_FILE} 2> /dev/null > /dev/null
+                WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
+        else(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
+            add_custom_target(doc-mo
+                COMMAND ${DOXYGEN_EXECUTABLE} ${MO_DOC_CONFIG_FILE}
+                WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
+        endif(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
+    endif(DOXYGEN_EXECUTABLE)
+    configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${MO_DOC_CONFIG_FILE}.cmake"
+                   "${MO_DOC_DIR}/${MO_DOC_CONFIG_FILE}")
+    install(
+        DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        DESTINATION local/share${INSTALL_SUB_DIR}/mo COMPONENT doc
+        PATTERN "CMakeFiles" EXCLUDE
+        PATTERN "cmake_install.cmake" EXCLUDE
+        PATTERN "CTestTestfile.cmake" EXCLUDE
+        PATTERN "Makefile" EXCLUDE
+        PATTERN "mo.cfg" EXCLUDE
+        PATTERN "mo.doxytag" EXCLUDE
+    )
+else(DOXYGEN_FOUND)
+    message(STATUS "Unable to generate the documentation, Doxygen package not found")
+endif(DOXYGEN_FOUND)
+

mo/doc/index.h

@@ -0,0 +1,52 @@
+/** @mainpage Welcome to ParadisEO-MO
+
+@section Introduction
+
+ParadisEO-MO is a white-box object-oriented generic framework dedicated to the flexible design of local search algorithms (hill-climbing, tabu search, simulated annealing, ...)
+
+@section tutorials Tutorials
+
+Tutorials for ParadisEO-MO are available in the "Tutorials section" of the <a href="http://paradiseo.gforge.inria.fr">ParadisEO website</a>.
+
+@section Design
+
+For an introduction to the design of ParadisEO-MO,
+you can look at the <a href="http://paradiseo.gforge.inria.fr">ParadisEO website</a>.
+
+@section LICENSE
+
+ This software is governed by the CeCILL license under French law and
+ abiding by the rules of distribution of free software.  You can  use,
+ modify and/ or redistribute the software under the terms of the CeCILL
+ license as circulated by CEA, CNRS and INRIA at the following URL
+ "http://www.cecill.info".
+
+ As a counterpart to the access to the source code and  rights to copy,
+ modify and redistribute granted by the license, users are provided only
+ with a limited warranty  and the software's author,  the holder of the
+ economic rights,  and the successive licensors  have only  limited liability.
+
+ In this respect, the user's attention is drawn to the risks associated
+ with loading,  using,  modifying and/or developing or reproducing the
+ software by the user in light of its specific status of free software,
+ that may mean  that it is complicated to manipulate,  and  that  also
+ therefore means  that it is reserved for developers  and  experienced
+ professionals having in-depth computer knowledge. Users are therefore
+ encouraged to load and test the software's suitability as regards their
+ requirements in conditions enabling the security of their systems and/or
+ data to be ensured and,  more generally, to use and operate it in the
+ same conditions as regards security.
+ The fact that you are presently reading this means that you have had
+ knowledge of the CeCILL license and that you accept its terms.
+
+ ParadisEO WebSite : http://paradiseo.gforge.inria.fr
+ Contact: paradiseo-help@lists.gforge.inria.fr
+
+*/
+
+/** @page webpages Related webpages
+
+- ParadisEO <a href="http://paradiseo.gforge.inria.fr">homepage</a>
+- INRIA GForge <a href="http://gforge.inria.fr/projects/paradiseo/">project page</a>
+- <a href="../../README">README</a>
+*/