From e036d9bb558e47b73134ffd496c41d912edf073c Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Wed, 9 Sep 2020 20:56:08 +0200 Subject: [PATCH] docs: downcast mode documentation added --- docs/usage.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/usage.rst b/docs/usage.rst index 5dc4ee49..876ad4fd 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -114,9 +114,36 @@ To support this it requires some additional Conan build dependencies described i `Repository Structure and Dependencies`_. It also runs unit tests during Conan build. + +Conan Options +^^^^^^^^^^^^^ + +downcast_mode ++++++++++++++ + +**Values**: ``off``/``on``/``auto`` + +**Defaulted to**: ``on`` + +Specifies how :ref:`The Downcasting Facility` works: + +- ``off`` - no downcasting at all +- ``on`` - downcasting always forced -> compile-time errors in case of duplicated definitions +- ``automatic`` - downcasting automatically enabled if no collisions are present + CMake Options ^^^^^^^^^^^^^ +DOWNCAST_MODE ++++++++++++++ + +**Values**: ``OFF``/``ON``/``AUTO`` + +**Defaulted to**: ``ON`` + +Equivalent to `downcast`_. + + GENERATE_DOCS +++++++++++++