Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Small documentation fixes #87

Merged
merged 2 commits into from
Jul 3, 2024
Merged

Small documentation fixes #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27eab52
refactor: Add docs target to the "dev" preset
LeonMatthesKDAB Jul 2, 2024
a336efa
fix: broken link to "Reassigning a binding"
LeonMatthesKDAB Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CMakePresets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"CMAKE_BUILD_TYPE": "Debug",
"CMAKE_EXPORT_COMPILE_COMMANDS" : "ON",
"KDBindings_TESTS" : "ON",
"KDBindings_DOCS" : "ON",
"KDBindings_EXAMPLES" : "ON",
"KDBindings_ERROR_ON_WARNING": "ON"
}
Expand Down
14 changes: 7 additions & 7 deletions src/kdbindings/binding.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ class Binding : public PropertyUpdater<T>, public Private::Dirtyable
* @return std::unique_ptr<Binding<T, EvaluatorT>> A new Binding that is powered by the evaluator.
*
* *Note: For the difference between makeBinding and makeBoundProperty, see the
* ["Reassigning a Binding"](../../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
* ["Reassigning a Binding"](../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
*/
template<typename T, typename EvaluatorT>
inline std::unique_ptr<Binding<T, EvaluatorT>> makeBinding(EvaluatorT &evaluator, Property<T> &property)
Expand Down Expand Up @@ -153,7 +153,7 @@ inline std::unique_ptr<Binding<T, EvaluatorT>> makeBinding(EvaluatorT &evaluator
* @return std::unique_ptr<Binding<T, EvaluatorT>> A new Binding that combines the rootNode with the evaluator.
*
* *Note: For the difference between makeBinding and makeBoundProperty, see the
* ["Reassigning a Binding"](../../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
* ["Reassigning a Binding"](../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
*/
template<typename T, typename EvaluatorT>
inline std::unique_ptr<Binding<T, EvaluatorT>> makeBinding(EvaluatorT &evaluator, Private::Node<T> &&rootNode)
Expand All @@ -175,7 +175,7 @@ inline std::unique_ptr<Binding<T, EvaluatorT>> makeBinding(EvaluatorT &evaluator
* The Binding will be powered by the new evaluator.
*
* *Note: For the difference between makeBinding and makeBoundProperty, see the
* ["Reassigning a Binding"](../../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
* ["Reassigning a Binding"](../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
*/
template<typename EvaluatorT, typename Func, typename... Args, typename = std::enable_if_t<sizeof...(Args) != 0>, typename ResultType = Private::operator_node_result_t<Func, Args...>>
inline std::unique_ptr<Binding<ResultType, EvaluatorT>> makeBinding(EvaluatorT &evaluator, Func &&func, Args &&...args)
Expand Down Expand Up @@ -237,7 +237,7 @@ class Binding<T, ImmediateBindingEvaluator> : public Binding<T, BindingEvaluator
* An new Binding bound to an existing Property with immediate evaluation.
*
* *Note: For the difference between makeBinding and makeBoundProperty, see the
* ["Reassigning a Binding"](../../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
* ["Reassigning a Binding"](../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
*/
template<typename T>
inline std::unique_ptr<Binding<T, ImmediateBindingEvaluator>> makeBinding(Property<T> &property)
Expand Down Expand Up @@ -272,7 +272,7 @@ inline std::unique_ptr<Binding<T, ImmediateBindingEvaluator>> makeBinding(const
* @return std::unique_ptr<Binding<<T, ImmediateBindingEvaluator>> An new Binding bound to a root Node with immediate evaluation.
*
* *Note: For the difference between makeBinding and makeBoundProperty, see the
* ["Reassigning a Binding"](../../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
* ["Reassigning a Binding"](../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
*/
template<typename T>
inline std::unique_ptr<Binding<T, ImmediateBindingEvaluator>> makeBinding(Private::Node<T> &&rootNode)
Expand All @@ -292,7 +292,7 @@ inline std::unique_ptr<Binding<T, ImmediateBindingEvaluator>> makeBinding(Privat
* The Binding will feature immediate evaluation.
*
* *Note: For the difference between makeBinding and makeBoundProperty, see the
* ["Reassigning a Binding"](../../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
* ["Reassigning a Binding"](../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
*/
template<typename Func, typename... Args, typename = std::enable_if_t<sizeof...(Args) != 0>, typename ResultType = Private::operator_node_result_t<Func, Args...>>
inline std::unique_ptr<Binding<ResultType, ImmediateBindingEvaluator>> makeBinding(Func &&func, Args &&...args)
Expand Down Expand Up @@ -322,7 +322,7 @@ inline std::unique_ptr<Binding<ResultType, ImmediateBindingEvaluator>> makeBindi
* @return Property A new Property that is bound to the inputs
*
* *Note: For the difference between makeBinding and makeBoundProperty, see the
* ["Reassigning a Binding"](../../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
* ["Reassigning a Binding"](../getting-started/data-binding/#reassigning-a-binding) section in the Getting Started guide.*
*/
template<typename... T>
inline auto makeBoundProperty(T &&...args)
Expand Down