Documentation fixes and moved to FMI.jl #49
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ThummeTo
reviewed
Oct 17, 2023
ThummeTo
reviewed
Nov 3, 2023
| const fmi2FMUstate = Ptr{Cvoid} | ||
| const fmi2Component = Ptr{Cvoid} | ||
| const fmi2ComponentEnvironment = Ptr{Cvoid} | ||
| const fmi2Enum = Array{Array{String}} # TODO: remove, this is not part of the spec! | ||
| export fmi2Char, fmi2String, fmi2Boolean, fmi2Real, fmi2Integer, fmi2Byte, fmi2ValueReference, fmi2FMUstate, fmi2Component, fmi2ComponentEnvironment, fmi2Enum | ||
|
|
||
| const fmi2Status = Cuint |
There was a problem hiding this comment.
why is the declaration seperated from the doc string now?
(doc string starts in L44, declaration is in L36)
There was a problem hiding this comment.
because otherwise each status would need its own docstring. Even if that option is preferred, I recommend to implement it in the future and go with this solution for now
| const fmi2StatusError = Cuint(3) | ||
| const fmi2StatusFatal = Cuint(4) | ||
| const fmi2StatusPending = Cuint(5) | ||
| fmi2Status, fmi2StatusOK, fmi2StatusWarning, fmi2StatusDiscard, fmi2StatusError, fmi2StatusFatal, fmi2StatusPending |
There was a problem hiding this comment.
what's this? (list of status codes)
There was a problem hiding this comment.
same here: one docstring for all codes (take note of the line numbers, github's formatting here is unhelpful)
| """ | ||
| `fmi3Boolean` TODO | ||
| """ | ||
| fmi3False, fmi3True |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.