Skip to content

Commit 2eaecfb

Browse files
committed
Minor formatting issue in some functions docus corrected
1 parent a3f179f commit 2eaecfb

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

src/CodeGeneration.jl

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1858,7 +1858,7 @@ end
18581858
"""
18591859
value = Modia.copy_scalar_x_segmented_value_from_state(instantiatedModel, startIndex)
18601860
1861-
Return value of scalar x_segmented variable from state vector `x` by providing its `startIndex`
1861+
Return value of scalar `x_segmented` variable from state vector `x` by providing its `startIndex`
18621862
(returned from `new_x_segmented_variable!(..)`).
18631863
"""
18641864
copy_scalar_x_segmented_value_from_state(m::InstantiatedModel, startIndex::Int) = m.x_segmented[startIndex]
@@ -1867,7 +1867,7 @@ copy_scalar_x_segmented_value_from_state(m::InstantiatedModel, startIndex::Int)
18671867
"""
18681868
value = Modia.copy_SVector3_x_segmented_value_from_state(instantiatedModel, startIndex)
18691869
1870-
Return value of `SVector{3,FloatType}` x_segmented variable from state vector `x` by providing its `startIndex`
1870+
Return value of `SVector{3,FloatType} x_segmented` variable from state vector `x` by providing its `startIndex`
18711871
(returned from `new_x_segmented_variable!(..)`).
18721872
"""
18731873
@inline copy_SVector3_x_segmented_value_from_state(m::InstantiatedModel{FloatType,TimeType}, startIndex::Int) where {FloatType,TimeType} = begin
@@ -1876,9 +1876,10 @@ Return value of `SVector{3,FloatType}` x_segmented variable from state vector `x
18761876
end
18771877

18781878
"""
1879-
Modia.copy_Vector_x_segmented_value_from_state(instantiatedModel::InstantiatedModel, startIndex, xi::Vector{FloatType})::Nothing
1879+
Modia.copy_Vector_x_segmented_value_from_state(
1880+
instantiatedModel::InstantiatedModel, startIndex, xi::Vector{FloatType})::Nothing
18801881
1881-
Return value of `Vector{FloatType}` x_segmented variable from state vector `x` by providing its `startIndex`
1882+
Return value of `Vector{FloatType} x_segmented` variable from state vector `x` by providing its `startIndex`
18821883
(returned from `new_x_segmented_variable!(..)`) and copying it into the pre-allocated vector `xi`.
18831884
"""
18841885
@inline function copy_Vector_x_segmented_value_from_state(m::InstantiatedModel{FloatType,TimeType}, startIndex::Int, xi::Vector{FloatType})::Nothing where {FloatType,TimeType}
@@ -1888,7 +1889,9 @@ end
18881889

18891890

18901891
"""
1891-
Modia.copy_der_x_segmented_value_to_state(instantiatedModel, startIndex, der_x_segmented_value::[FloatType|Vector{FloatType}])
1892+
Modia.copy_der_x_segmented_value_to_state(
1893+
instantiatedModel, startIndex,
1894+
der_x_segmented_value::[FloatType|Vector{FloatType}])
18921895
18931896
Copy `der_x_segmented_value` to state derivative vector `der(x)` by providing its `startIndex`
18941897
(returned from `new_x_segmented_variable!(..)`) and copying it into the pre-allocated vector `der_x_segmented_value`.
@@ -1904,7 +1907,9 @@ end
19041907

19051908

19061909
"""
1907-
Modia.copy_w_segmented_value_to_result(instantiatedModel::InstantiatedModel, index::Int, w_segmented_value)::Nothing
1910+
Modia.copy_w_segmented_value_to_result(
1911+
instantiatedModel::InstantiatedModel, index::Int,
1912+
w_segmented_value)::Nothing
19081913
19091914
Copy value of local variable (`w-segmented`) to result by providing its `index`
19101915
(returned from `new_w_segmented_variable!`),

0 commit comments

Comments
 (0)