diff options
| author | Valeriy Kopylov <valery.kopylov@akvelon.com> | 2015-04-23 13:21:22 +0300 |
|---|---|---|
| committer | Valeriy Kopylov <valery.kopylov@akvelon.com> | 2015-04-23 13:21:22 +0300 |
| commit | 71f260aa7fd6cc413770a41ae03d57b5c06b5fd7 (patch) | |
| tree | 719c9ab266a461336605587fb5735d97bd28e680 /projects | |
| parent | 0f84a2664abe0ab10cc2195b97316f07817be7e9 (diff) | |
| download | RxCpp-71f260aa7fd6cc413770a41ae03d57b5c06b5fd7.tar.gz | |
Add the main page for doxygen
Diffstat (limited to 'projects')
| -rw-r--r-- | projects/CMake/CMakeLists.txt | 11 | ||||
| -rw-r--r-- | projects/doxygen/doxygen.conf.in | 6 | ||||
| -rw-r--r-- | projects/doxygen/mainpage.dox | 13 |
3 files changed, 24 insertions, 6 deletions
diff --git a/projects/CMake/CMakeLists.txt b/projects/CMake/CMakeLists.txt index b645d64..a83ae21 100644 --- a/projects/CMake/CMakeLists.txt +++ b/projects/CMake/CMakeLists.txt @@ -127,14 +127,17 @@ set_tests_properties(ListTags PROPERTIES PASS_REGULAR_EXPRESSION "[0-9]+ tags") # target to generate documentation with Doxygen find_package(Doxygen) if(DOXYGEN_FOUND) - set(DOXY_CONF ${RXCPP_DIR}/projects/doxygen/doxygen.conf) + set(DOXY_CONF_DIR ${RXCPP_DIR}/projects/doxygen) + set(DOXY_CONF_FILE ${DOXY_CONF_DIR}/doxygen.conf) + set(DOXY_MAIN_FILE ${DOXY_CONF_DIR}/mainpage.dox) set(DOXY_OUTPUT_DIR ${RXCPP_DIR}/projects/doxygen) - set(DOXY_INPUT_DIR "${IX_SRC_DIR} ${RX_SRC_DIR}") + set(DOXY_INPUT_DIR "${IX_SRC_DIR} ${RX_SRC_DIR} ${DOXY_MAIN_FILE}") + set(DOXY_INCLUDE_DIR ${RXCPP_DIR}) - configure_file(${DOXY_CONF}.in ${DOXY_CONF}) + configure_file(${DOXY_CONF_FILE}.in ${DOXY_CONF_FILE}) add_custom_target(doc - COMMAND ${DOXYGEN_EXECUTABLE} ${DOXY_CONF} + COMMAND ${DOXYGEN_EXECUTABLE} ${DOXY_CONF_FILE} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating documentation with Doxygen" VERBATIM) diff --git a/projects/doxygen/doxygen.conf.in b/projects/doxygen/doxygen.conf.in index 1ed8ca0..7f95e3e 100644 --- a/projects/doxygen/doxygen.conf.in +++ b/projects/doxygen/doxygen.conf.in @@ -238,7 +238,9 @@ TAB_SIZE = 4 # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. -ALIASES = +ALIASES = "sample=@par Sample Code\n" \ + "badcode=@par Bad Code\n" \ + "goodcode=@par Good Code\n" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" @@ -877,7 +879,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = +EXAMPLE_PATH = ${DOXY_INCLUDE_DIR} # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and diff --git a/projects/doxygen/mainpage.dox b/projects/doxygen/mainpage.dox new file mode 100644 index 0000000..3d55224 --- /dev/null +++ b/projects/doxygen/mainpage.dox @@ -0,0 +1,13 @@ +/*! + \mainpage + + \htmlinclude Readme.html + + \par See also + + RxCpp sources --- https://github.com/Reactive-Extensions/RxCpp + + Introduction to Rx --- http://www.introtorx.com + + Reactive Extensions portal --- http://reactivex.io +*/ |