diff options
| author | Kirk Shoop <kirk.shoop@microsoft.com> | 2015-04-24 16:44:05 -0700 |
|---|---|---|
| committer | Kirk Shoop <kirk.shoop@microsoft.com> | 2015-04-24 16:44:05 -0700 |
| commit | b1dd5d5c18553a9f1704a8d7ae64bca5f3b85d10 (patch) | |
| tree | 047563dffef47c5d5bac11fc17d7a2cd9820ae08 /projects | |
| parent | 9b2e07af319fefa1053f327ee07add4cf58dde19 (diff) | |
| download | RxCpp-b1dd5d5c18553a9f1704a8d7ae64bca5f3b85d10.tar.gz | |
adding docs in order to update readme.html code
Diffstat (limited to 'projects')
| -rw-r--r-- | projects/CMake/CMakeLists.txt | 6 | ||||
| -rw-r--r-- | projects/doxygen/mainpage.dox | 28 |
2 files changed, 24 insertions, 10 deletions
diff --git a/projects/CMake/CMakeLists.txt b/projects/CMake/CMakeLists.txt index 090b31a..56f94d2 100644 --- a/projects/CMake/CMakeLists.txt +++ b/projects/CMake/CMakeLists.txt @@ -130,10 +130,10 @@ if(DOXYGEN_FOUND) # Doxygen configuration set(DOXY_CONF_DIR ${RXCPP_DIR}/projects/doxygen) set(DOXY_CONF_FILE ${DOXY_CONF_DIR}/doxygen.conf) - + # File with main page (index.html) content set(DOXY_MAIN_PAGE ${DOXY_CONF_DIR}/mainpage.dox) - + # Sources for processing location set(DOXY_INPUT_DIR "${IX_SRC_DIR} ${RX_SRC_DIR} ${DOXY_MAIN_PAGE}") @@ -154,6 +154,8 @@ if(DOXYGEN_FOUND) set(DOXY_EXAMPLE_SRC_LIST ${DOXY_EXAMPLES_SRC_DIR}/main.cpp ${DOXY_EXAMPLES_SRC_DIR}/create.cpp + ${DOXY_EXAMPLES_SRC_DIR}/iterate.cpp + ${DOXY_EXAMPLES_SRC_DIR}/range.cpp ) set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${DOXY_EXAMPLES_BIN_DIR}) set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG ${DOXY_EXAMPLES_BIN_DIR}) diff --git a/projects/doxygen/mainpage.dox b/projects/doxygen/mainpage.dox index 3d55224..348215a 100644 --- a/projects/doxygen/mainpage.dox +++ b/projects/doxygen/mainpage.dox @@ -1,13 +1,25 @@ /*! - \mainpage - - \htmlinclude Readme.html - - \par See also - - RxCpp sources --- https://github.com/Reactive-Extensions/RxCpp - + \mainpage + + RxCpp is an implementation of the Observable/Observer pattern and a set of operations. It is an async equivalent of the container/iterator pattern and the set of algorithms found in the STL. + + \par Resources for Learning about Reactive Extentions + Introduction to Rx --- http://www.introtorx.com + Interactive diagrams of Rx Observables --- http://rxmarbles.io + Reactive Extensions portal --- http://reactivex.io + + Reactive Extensions tutorial --- http://reactive-extensions.github.io/learnrx/ + + \par RxCpp specific + + Start here --- \ref group-core + + Github --- https://github.com/Reactive-Extensions/RxCpp + + \par readme.html + + \htmlinclude Readme.html */ |