Skip to content

Commit c981527

Browse files
authored
Merge pull request #190 from thelfer/188-document-the-integrate_debug-in-the-release-notes-make-appropriate-links-in-the-documentation
Fix Issue #188
2 parents 60d3e8e + a678116 commit c981527

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

docs/web/bindings-cxx.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -464,6 +464,12 @@ argument of the `ThreadPool` type allowing a parallelization of the
464464
behaviour integration. The user may refer to the `IntegrateTest2b.cxx`
465465
file to have an example on how this use this second overload.
466466

467+
> ** Note **
468+
>
469+
> The `integrate_debug` function can be used to generate debug files
470+
> to analyse integration failures. See
471+
> [this page](behaviour-integration-failure-analysis.html) for details.
472+
467473
# Support for behaviours' initialize functions {#sec:mgis:2.1:initialize_functions}
468474

469475
Since version 4.1, `MFront` behaviours can declare initialize functions

docs/web/release-notes-3.1.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,21 @@ The `MGIS/Function` library is described on [this page](functions.html).
6767

6868
# Improvements
6969

70+
## The `integrate_debug` functions
71+
72+
The `integrate_debug` function can be used to generate debug files to
73+
analyse integration failures. This function is very customizable, see
74+
[this page](behaviour-integration-failure-analysis.html) for details.
75+
76+
### Example of usage
77+
78+
This snippet shows that the `integrate_debug` functions can be used as
79+
drop-in replacement for the `integrate` function.
80+
81+
~~~~{.cxx}
82+
const auto r = integrate_debug(v, b);
83+
~~~~
84+
7085
## `getDatabase` and `loadFromDatabase`
7186

7287
> **Note**

0 commit comments

Comments
 (0)