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

fixes for docs #122

Closed
wants to merge 14 commits into from
Closed

fixes for docs #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
dba0a36
doc fixes + function exports
0815Creeper Sep 29, 2023
1a4533b
fixes for fmi.jl doc; moved doc to fmi.jl
0815Creeper Oct 6, 2023
8154c62
doc fixes
0815Creeper Oct 10, 2023
666ed9a
doc fixes
0815Creeper Oct 16, 2023
c20ad49
changed logWarn to logWarning
0815Creeper Oct 17, 2023
b78f08d
Merge branch 'main' of https://github.com/0815Creeper/FMIImport.jl in…
ThummeTo Nov 6, 2023
92a9721
removed outdated file
ThummeTo Nov 6, 2023
9571d58
removed documentation action
ThummeTo Nov 6, 2023
1e3b745
Merge pull request #1 from ThummeTo/0815Creeper-main
0815Creeper Nov 9, 2023
13cfa25
minor docstring fix
0815Creeper Nov 9, 2023
6ac2460
docstring fixes: fmi2FreeFMUstate! no longer exists
0815Creeper Aug 23, 2024
35d45d3
Merge branch 'ThummeTo:main' into patch-docs
0815Creeper Aug 23, 2024
bd2ad82
Update README.md
0815Creeper Aug 23, 2024
5e8e044
Update README.md
0815Creeper Aug 23, 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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
# FMIImport.jl

## What is FMIImport.jl?
[*FMIImport.jl*](https://github.com/ThummeTo/FMIImport.jl) implements the import functionalities of the FMI-standard ([fmi-standard.org](http://fmi-standard.org/)) for the Julia programming language.
[*FMIImport.jl*](https://github.com/ThummeTo/FMIImport.jl) implements the import functionalities of the FMI-standard ([fmi-standard.org](https://fmi-standard.org/)) for the Julia programming language.
[*FMIImport.jl*](https://github.com/ThummeTo/FMIImport.jl) provides the foundation for the Julia packages [*FMI.jl*](https://github.com/ThummeTo/FMI.jl) and [*FMIFlux.jl*](https://github.com/ThummeTo/FMIFlux.jl).


[![Dev Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://ThummeTo.github.io/FMI.jl/dev)
[![Dev Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://thummeto.github.io/FMI.jl/dev/)
[![Run Tests](https://github.com/ThummeTo/FMIImport.jl/actions/workflows/Test.yml/badge.svg)](https://github.com/ThummeTo/FMIImport.jl/actions/workflows/Test.yml)
[![Run PkgEval](https://github.com/ThummeTo/FMIImport.jl/actions/workflows/Eval.yml/badge.svg)](https://github.com/ThummeTo/FMIImport.jl/actions/workflows/Eval.yml)
[![Coverage](https://codecov.io/gh/ThummeTo/FMIImport.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ThummeTo/FMIImport.jl)
[![Coverage](https://app.codecov.io/gh/ThummeTo/FMIImport.jl/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ThummeTo/FMIImport.jl)
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)

Expand Down
2 changes: 1 addition & 1 deletion src/FMI2/c.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -914,7 +914,7 @@ More detailed:
- FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
- FMISpec2.0.2[p.25]: 2.1.8 Getting and Setting the Complete FMU State

See also [`fmi2FreeFMUstate!`](@ref).
See also [`fmi2FreeFMUstate`](@ref).
"""
function FMICore.fmi2FreeFMUstate(c::FMU2Component, FMUstate::Ref{fmi2FMUstate})

Expand Down
2 changes: 1 addition & 1 deletion src/FMI2/int.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -945,7 +945,7 @@ Free the memory for the allocated FMU state
- FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
- FMISpec2.0.2[p.25]: 2.1.8 Getting and Setting the Complete FMU State

See also [`fmi2FreeFMUstate!`](@ref).
See also [`fmi2FreeFMUstate`](@ref).
"""
function fmi2FreeFMUstate(c::FMU2Component, state::fmi2FMUstate)
stateRef = Ref(state)
Expand Down
1 change: 0 additions & 1 deletion src/FMI3/int.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2325,7 +2325,6 @@ function fmi3SetClock(
end

"""

fmi3GetFMUState(c::FMU3Instance)

Makes a copy of the internal FMU state and returns a pointer to this copy.
Expand Down
Loading