Doc update.

Signed-off-by: Timothy Rule (VM/EMT3) <[email protected]>
boschglobal · Nov 12, 2024 · f956c2a · f956c2a
1 parent 8a7dbe8
commit f956c2a
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 66 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -28,14 +28,14 @@ DOC_OUTPUT_index := doc/content/apis/fmi/_index.md
 DOC_INPUT_fmimcl := dse/fmimcl/fmimcl.h
 DOC_CDIR_fmimcl := dse/fmimcl/engine.c,dse/fmimcl/fmimcl.c,dse/fmimcl/model.c,dse/fmimcl/parser.c
 DOC_OUTPUT_fmimcl := doc/content/apis/fmi/fmimcl/index.md
-DOC_LINKTITLE_fmimcl := FMI MCL
-DOC_TITLE_fmimcl := "FMI Model Compatibility Library API Reference"
+DOC_LINKTITLE_fmimcl := MCL
+DOC_TITLE_fmimcl := "FMI MCL API Reference"
 
 # Module "fmimodelc"
 DOC_INPUT_fmimodelc := dse/fmimodelc/fmimodelc.h
 DOC_CDIR_fmimodelc := dse/fmimodelc/ascii85.c,dse/fmimodelc/fmi2fmu.c,dse/fmimodelc/runtime.c
 DOC_OUTPUT_fmimodelc := doc/content/apis/fmi/fmimodelc/index.md
-DOC_LINKTITLE_fmimodelc := FMI ModelC FMU
+DOC_LINKTITLE_fmimodelc := "ModelC FMU"
 DOC_TITLE_fmimodelc := "FMI ModelC FMU API Reference"
 
 # Targets

diff --git a/doc/content/apis/fmi/fmimcl/index.md b/doc/content/apis/fmi/fmimcl/index.md
@@ -1,6 +1,6 @@
 ---
-title: FMI Model Compatibility Library API Reference
-linkTitle: FMI
+title: FMI MCL API Reference
+linkTitle: MCL
 ---
 ## FMI Model Compatibility Library
 

diff --git a/doc/content/apis/fmi/fmimodelc/index.md b/doc/content/apis/fmi/fmimodelc/index.md
@@ -1,81 +1,85 @@
 ---
 title: FMI ModelC FMU API Reference
-linkTitle: FMI
+linkTitle: ModelC FMU
 ---
-## fmi2ExitInitializationMode
-
+## fmi2GetReal
 
-Initialise the Model Runtime (of the ModelC library) and in the process
-establish the simulation that this ModelC FMU is wrapping/operating.
 
-This function will generate indexes to map between FMI Variables and ModelC
-Signals; both scaler signals (double) and binary signals (string/binary).
+Get values for the provided list of value references.
 
 ### Parameters
 
 c (fmi2Component*)
 : An Fmu2InstanceData object representing an instance of this FMU.
 
+vr (fmi2ValueReference[])
+: List of value references to retrieve.
+
+nvr (int)
+: The number of value references to retrieve.
+
+value (fmi2Real[])
+: Storage for the retrieved values.
+
 ### Returns
 
 fmi2OK (fmi2Status)
-: The simulation that this FMU represents is ready to be operated.
+: The requested variables are retrieved (where available).
 
 
 
-## fmi2GetReal
+## fmi2DoStep
 
 
-Get values for the provided list of value references.
+Set values for the provided list of value references and values. String/Binary
+variables are always appended to the ModelC Binary Signal.
+
+> Note: If several variables are indexed against the same ModelC Binary Signal,
+  for instance in a Bus Topology, then each variable will be appended to that
+  ModelC Binary Signal.
 
 ### Parameters
 
 c (fmi2Component*)
 : An Fmu2InstanceData object representing an instance of this FMU.
 
-vr (fmi2ValueReference[])
-: List of value references to retrieve.
+currentCommunicationPoint (fmi2Real)
+: The model time (for the start of this step).
 
-nvr (int)
-: The number of value references to retrieve.
+communicationStepSize (fmi2Real)
+: The model step size.
 
-value (fmi2Real[])
-: Storage for the retrieved values.
+noSetFMUStatePriorToCurrentPoint (fmi2Boolean)
+: Not used.
 
 ### Returns
 
 fmi2OK (fmi2Status)
-: The requested variables are retrieved (where available).
-
-
-
-## FMI ModelC FMU
-
+: The step completed.
 
-The FMI ModelC FMU is and FMU which is capable of loading and running a
-DSE Simulation (e.g. a ModelC Simulation Stack). All capabilites of the ModelC
-Runtime are supported, including the exchange of binary signals (e.g. CAN) and
-realisation of bus topologies (e.g. multi-node CAN Networks).
+fmi2Error (fmi2Status)
+: An error occurred when stepping the ModelC Simulation.
 
 
-### Component Diagram
 
-<div hidden>
+## fmi2ExitInitializationMode
 
-```
-@startuml fmimodelc-component
 
-title FMI ModelC FMU
+Initialise the Model Runtime (of the ModelC library) and in the process
+establish the simulation that this ModelC FMU is wrapping/operating.
 
-center footer Dynamic Simulation Environment
+This function will generate indexes to map between FMI Variables and ModelC
+Signals; both scaler signals (double) and binary signals (string/binary).
 
-@enduml
-```
+### Parameters
 
-</div>
+c (fmi2Component*)
+: An Fmu2InstanceData object representing an instance of this FMU.
 
-![](fmimodelc-component.png)
+### Returns
 
+fmi2OK (fmi2Status)
+: The simulation that this FMU represents is ready to be operated.
 
 
 
@@ -162,49 +166,45 @@ fmi2OK (fmi2Status)
 
 
 
-## fmi2DoStep
+## fmi2FreeInstance
 
 
-Set values for the provided list of value references and values. String/Binary
-variables are always appended to the ModelC Binary Signal.
-
-> Note: If several variables are indexed against the same ModelC Binary Signal,
-  for instance in a Bus Topology, then each variable will be appended to that
-  ModelC Binary Signal.
+Free memory and resources related to the provided FMU instance.
 
 ### Parameters
 
 c (fmi2Component*)
 : An Fmu2InstanceData object representing an instance of this FMU.
 
-currentCommunicationPoint (fmi2Real)
-: The model time (for the start of this step).
 
-communicationStepSize (fmi2Real)
-: The model step size.
 
-noSetFMUStatePriorToCurrentPoint (fmi2Boolean)
-: Not used.
+## FMI ModelC FMU
 
-### Returns
 
-fmi2OK (fmi2Status)
-: The step completed.
+The FMI ModelC FMU is and FMU which is capable of loading and running a
+DSE Simulation (e.g. a ModelC Simulation Stack). All capabilites of the ModelC
+Runtime are supported, including the exchange of binary signals (e.g. CAN) and
+realisation of bus topologies (e.g. multi-node CAN Networks).
 
-fmi2Error (fmi2Status)
-: An error occurred when stepping the ModelC Simulation.
 
+### Component Diagram
 
+<div hidden>
 
-## fmi2FreeInstance
+```
+@startuml fmimodelc-component
 
+title FMI ModelC FMU
 
-Free memory and resources related to the provided FMU instance.
+center footer Dynamic Simulation Environment
 
-### Parameters
+@enduml
+```
+
+</div>
+
+![](fmimodelc-component.png)
 
-c (fmi2Component*)
-: An Fmu2InstanceData object representing an instance of this FMU.
 
 
 

diff --git a/doc/content/docs/user/fmi/fmigateway/index.md b/doc/content/docs/user/fmi/fmigateway/index.md
@@ -1,6 +1,6 @@
 ---
 title: "FMI Gateway FMU"
-linkTitle: "FMI Gateway"
+linkTitle: "Gateway FMU"
 weight: 200
 tags:
 - FMI

diff --git a/doc/content/docs/user/fmi/fmimodelc/index.md b/doc/content/docs/user/fmi/fmimodelc/index.md
@@ -1,6 +1,6 @@
 ---
 title: "FMI ModelC FMU"
-linkTitle: "FMI ModelC"
+linkTitle: "ModelC FMU"
 weight: 600
 tags:
 - FMI