Skip to content

Commit b193878

Browse files
committed
Small fixes in the docs
1 parent 28c6b1c commit b193878

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

docs/classes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@ has_children: true
66
---
77

88
# Classes to define DAE system
9+
10+
This section describes all classes needed to define the DAE system.
11+
{: .fs-6 .fw-300}

docs/quick-start.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@ Below is a simplified procedure of defining and solving the given DAE system usi
5151
#include <dae-cpp/solver.hpp>
5252
```
5353

54+
Optionally, the `daecpp` namespace can be added to the project:
55+
56+
```cpp
57+
using namespace daecpp;
58+
```
59+
60+
Alternatively, use `daecpp::` prefix for all `dae-cpp` types and classes.
61+
5462
### Step 1. Define the mass matrix of the system
5563

5664
The mass matrix contains only one non-zero element:

docs/solver-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav_order: 7
66

77
# Solver Options class
88

9-
The Solver Options class, `daecpp::SolverOptions,` allows the user to redefine and fine-tune the DAE solver options. To do so, the user should create an object of the Solver Options class, update parameters of interest by accessing public variables (see [example](#example) below), and then provide the updated object to the solver function `solve`.
9+
The Solver Options class, `daecpp::SolverOptions`, allows the user to redefine and fine-tune the DAE solver options. To do so, the user should create an object of the Solver Options class, update parameters of interest by accessing public variables (see [example](#example) below), and then provide the updated object to the solver function `solve`.
1010

1111
The table below contains a complete list of all options accessible via the Solver Options class.
1212

0 commit comments

Comments
 (0)