Skip to content

Commit

Permalink
Update Documentation (#80)
Browse files Browse the repository at this point in the history
* Update Doc-String | modified:   src/FMI2/c.jl
        modified:   src/FMI2/ext.jl
        modified:   src/FMI2/int.jl
        modified:   src/FMI2/md.jl

* Update Doc-String |  modified:   docs/src/fmi2_library.md
        modified:   src/FMI2/convert.jl
        modified:   src/FMI2/ext.jl
        modified:   src/FMI2/int.jl

* Update src/ and docs/

* Update src/

* Update docs/src/ and src/FMI2

* Update src/FMI2/int.jl

* Update src/FMI2/md.jl

* Doc-Update

* Doc-Update

* Update doc/

* Update docs/

* Update docs/

* Update Doc-String

* describe missing parameters in Docstings

* Update docs/src/fmi2_library.md
  • Loading branch information
adribrune committed Mar 23, 2023
1 parent a136d97 commit 4be373d
Show file tree
Hide file tree
Showing 9 changed files with 190 additions and 314 deletions.
2 changes: 2 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ makedocs(sitename="FMIImport.jl",
sidebar_sitename = false,
edit_link = nothing
),
modules = [FMIImport],
checkdocs = :exports,
pages= Any[
"Introduction" => "index.md"
"Examples" => "overview.md"
Expand Down
18 changes: 5 additions & 13 deletions docs/src/fmi2_library.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# [FMI2 Library Functions](@id library)

## FMI2 Common Concepts for Model Exchange and Co-Simulation
Expand Down Expand Up @@ -30,6 +31,7 @@ fmi2IsModelExchange

#### Information functions


```@docs
fmi2DependenciesSupported
fmi2DerivativeDependenciesSupported
Expand Down Expand Up @@ -89,7 +91,7 @@ attributes)].
```@docs
fmi2Get
fmi2Get!
fmiSet
fmi2Set
fmi2GetReal
fmi2GetReal!
fmi2GetInteger
Expand Down Expand Up @@ -127,6 +129,7 @@ means computing the partial derivatives at a particular time instant. For Co-Sim
compute the partial derivatives at a particular communication point. One function is provided to compute
directional derivatives. This function can be used to construct the desired partial derivative matrices.


```@docs
fmi2GetDirectionalDerivative!
fmi2SetRealInputDerivatives
Expand All @@ -146,15 +149,12 @@ Depending on the situation, different variables need to be computed. In order to
```@docs
fmi2SetTime
fmi2SetContinuousStates
fmi2SetReal
fmi2SetInteger
fmi2SetBoolean
fmi2SetString
```

### Evaluation of Model Equations
This section contains the core functions to evaluate the model equations.


```@docs
fmi2EnterEventMode
fmi2NewDiscreteStates
Expand Down Expand Up @@ -185,7 +185,6 @@ derivatives of the inputs with respect to time can be provided. Also, higher der
higher order interpolation.

```@docs
fmi2SetRealInputDerivatives
fmi2GetRealOutputDerivatives
```

Expand Down Expand Up @@ -223,7 +222,6 @@ fmi2Reload
```@docs
fmi2StringToValueReference
fmi2ModelVariablesForValueReference
fmi2StringToValueReference
fmi2ValueReferenceToString
fmi2GetSolutionState
fmi2GetSolutionValue
Expand All @@ -233,16 +231,10 @@ fmi2GetSolutionTime
### External/Additional functions

```@docs
fmi2Instantiate!
fmi2SampleJacobian
fmi2SampleJacobian!
fmi2GetJacobian
fmi2GetJacobian!
fmi2GetFullJacobian
fmi2GetFullJacobian!
fmi2Get!
fmi2Get
fmi2Set
fmi2GetStartValue
fmi2GetUnit
fmi2GetDeclaredType
Expand Down
Loading

0 comments on commit 4be373d

Please sign in to comment.