diff options
| -rw-r--r-- | Eigen/Core/DynBlock.h | 2 | ||||
| -rw-r--r-- | Mainpage.dox | 2 | ||||
| -rw-r--r-- | doc/CMakeLists.txt | 12 | ||||
| -rw-r--r-- | doc/Doxyfile.in | 4 | ||||
| -rw-r--r-- | doc/examples/CMakeLists.txt | 3 | ||||
| -rw-r--r-- | doc/snippets/CMakeLists.txt | 3 |
6 files changed, 23 insertions, 3 deletions
diff --git a/Eigen/Core/DynBlock.h b/Eigen/Core/DynBlock.h index 39c83584d..cfd2cb082 100644 --- a/Eigen/Core/DynBlock.h +++ b/Eigen/Core/DynBlock.h @@ -42,6 +42,8 @@ * \include class_DynBlock.cpp * Output: * \verbinclude class_DynBlock.out + * + * \sa MatrixBase::dynBlock() */ template<typename MatrixType> class DynBlock : public MatrixBase<typename MatrixType::Scalar, DynBlock<MatrixType> > diff --git a/Mainpage.dox b/Mainpage.dox index 893e05da4..eeb437a58 100644 --- a/Mainpage.dox +++ b/Mainpage.dox @@ -11,6 +11,6 @@ In order to generate the documentation for Eigen, follow these steps: <li>now generate the documentaion: <pre>make</pre> or, if you have two CPUs, <pre>make -j2</pre> Note that this will compile the examples, run them, and integrate their output into the documentation. This is why it can take some time.</li> </ul> -You will now find in the build directory a 'html' subdirectory containing the HTML documentation for Eigen. +You will now find the HTML documentation in the doc/html/ subdirectory of the build directory. */ diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 90228f071..39af38afe 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -5,7 +5,19 @@ CONFIGURE_FILE( ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile ) +SET(examples_targets "") +SET(snippets_targets "") + ADD_SUBDIRECTORY(examples) ADD_SUBDIRECTORY(snippets) +ADD_CUSTOM_TARGET( + run_doxygen + ALL + COMMAND doxygen + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} +) + +ADD_DEPENDENCIES(run_doxygen all_snippets all_examples) + ENDIF(BUILD_DOC) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 423a6eac6..4f0e4c200 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -6,7 +6,7 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = Eigen PROJECT_NUMBER = 2.0-alpha1 -OUTPUT_DIRECTORY = ${CMAKE_BINARY_DIR} +OUTPUT_DIRECTORY = ${CMAKE_BINARY_DIR}/doc CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES @@ -259,7 +259,7 @@ MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES +COLLABORATION_GRAPH = NO GROUP_GRAPHS = YES UML_LOOK = NO TEMPLATE_RELATIONS = NO diff --git a/doc/examples/CMakeLists.txt b/doc/examples/CMakeLists.txt index 8ced15735..29cf078c1 100644 --- a/doc/examples/CMakeLists.txt +++ b/doc/examples/CMakeLists.txt @@ -1,5 +1,7 @@ FILE(GLOB examples_SRCS "*.cpp") +ADD_CUSTOM_TARGET(all_examples) + FOREACH(example_src ${examples_SRCS}) GET_FILENAME_COMPONENT(example ${example_src} NAME_WE) ADD_EXECUTABLE(${example} ${example_src}) @@ -11,4 +13,5 @@ ADD_CUSTOM_COMMAND( COMMAND ${example_executable} ARGS >${CMAKE_CURRENT_BINARY_DIR}/${example}.out ) +ADD_DEPENDENCIES(all_examples ${example}) ENDFOREACH(example_src) diff --git a/doc/snippets/CMakeLists.txt b/doc/snippets/CMakeLists.txt index 85503e03d..faf6440e8 100644 --- a/doc/snippets/CMakeLists.txt +++ b/doc/snippets/CMakeLists.txt @@ -1,5 +1,7 @@ FILE(GLOB snippets_SRCS "*.cpp") +ADD_CUSTOM_TARGET(all_snippets) + FOREACH(snippet_src ${snippets_SRCS}) GET_FILENAME_COMPONENT(snippet ${snippet_src} NAME_WE) SET(compile_snippet_target compile_${snippet}) @@ -17,4 +19,5 @@ ADD_CUSTOM_COMMAND( COMMAND ${compile_snippet_executable} ARGS >${CMAKE_CURRENT_BINARY_DIR}/${snippet}.out ) +ADD_DEPENDENCIES(all_snippets ${compile_snippet_target}) ENDFOREACH(snippet_src) |