diff --git a/cmake/docs.cmake b/cmake/docs.cmake index 56cf4fe..5d149ab 100644 --- a/cmake/docs.cmake +++ b/cmake/docs.cmake @@ -1,10 +1,11 @@ # Documentation options set(DOXYGEN_EXTRACT_ALL YES) set(DOXYGEN_GENERATE_TREEVIEW YES) -set(DOXYGEN_EXCLUDE_PATTERNS */build/* */tests/* */build-docs/*) +set(DOXYGEN_EXCLUDE_PATTERNS */build/* */tests/* */build-docs/* paper.md) set(DOXYGEN_USE_MDFILE_AS_MAINPAGE ${CMAKE_SOURCE_DIR}/readme.md) set(DOXYGEN_EXAMPLE_PATH ${CMAKE_SOURCE_DIR}) -set(DOXYGENT_DOT_TRANSPARENT YES) +set(DOXYGEN_DOT_TRANSPARENT YES) +set(DOXYGEN_IMAGE_PATH ${CMAKE_SOURCE_DIR}) # ============================================================================== # Doxygen Awesome CSS diff --git a/readme.md b/readme.md index 67e7f90..3102e9e 100644 --- a/readme.md +++ b/readme.md @@ -44,6 +44,9 @@ The [Rule of Cheese](https://github.com/JPenuchot/rule-of-cheese) project can be used as an example of how to use `ctbench`. It is the project that gave birth to this tool and is maintained as `ctbench` evolves. +You may refer to the [CMake API reference](generated-docs/ctbench-api.md) for +more details. + ### Declaring a benchmark case target A benchmark case is represented by a C++ file. It will be "instanciated", ie. @@ -157,6 +160,19 @@ per benchmark case. In this case, you would then get 3 graphs (`ExecuteCompiler`, `Frontend`, and `Backend`) each with 5 curves (`enable_if`, `enable_if_t`, `if_constexpr`, `control`, and `requires`). +### Examples + +![](docs/images/ExecuteCompiler.svg) +**Clang ExecuteCompiler time curve from +[poacher](https://github.com/jpenuchot/poacher), +generated by the *compare_by* plotter** + +![](docs/images/InstantiateFunction.svg) + +**Clang InstantiateFunction time curve from +[poacher](https://github.com/jpenuchot/poacher), +generated by the *compare_by* plotter** + ## Additional - [ctbench: compile time benchmarking for Clang](