Skip to content

Commit

Permalink
Added PDF, section and page references for FMI2 DocLinks.
Browse files Browse the repository at this point in the history
  • Loading branch information
nickbattle committed Sep 14, 2024
1 parent 8cbe825 commit 5248c4c
Show file tree
Hide file tree
Showing 13 changed files with 40 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public void testFMI2() throws Exception
errors.get(0).message);
Assert.assertTrue(errors.get(0).doclinks != null);
Assert.assertEquals(
"<FMI2_STANDARD>#_definition_of_the_model_structure_modelstructure\n",
"<FMI2_STANDARD> Section 2.2.8, Page 58\n",
errors.get(0).doclinks.get(0).toString());

errors = checker.check(null, build, null);
Expand Down
4 changes: 2 additions & 2 deletions fmi2/rule-model/Rules/CoSimulation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endif::[]
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_header_files_and_naming_of_functions")
-- @DocLink("<FMI2_STANDARD> Section 2.1.1, Page 14")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -31,7 +31,7 @@ See <<_header_files_and_naming_of_functions>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_header_files_and_naming_of_functions")
-- @DocLink("<FMI2_STANDARD> Section 2.1.1, Page 14")
// {vdm}
endif::[]
// {vdm}
Expand Down
6 changes: 3 additions & 3 deletions fmi2/rule-model/Rules/DefaultExperiment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endif::[]
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_a_default_experiment_defaultexperiment")
-- @DocLink("<FMI2_STANDARD> Section 2.2.5, Page 45")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -30,7 +30,7 @@ See <<_definition_of_a_default_experiment_defaultexperiment>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_a_default_experiment_defaultexperiment")
-- @DocLink("<FMI2_STANDARD> Section 2.2.5, Page 45")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -48,7 +48,7 @@ See <<_definition_of_a_default_experiment_defaultexperiment>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_a_default_experiment_defaultexperiment")
-- @DocLink("<FMI2_STANDARD> Section 2.2.5, Page 45")
// {vdm}
endif::[]
// {vdm}
Expand Down
34 changes: 17 additions & 17 deletions fmi2/rule-model/Rules/FmiModelDescription.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endif::[]
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_inquire_platform_and_version_number_of_header_files")
-- @DocLink("<FMI2_STANDARD> Section 2.1.4, Page 19")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -31,7 +31,7 @@ See <<_inquire_platform_and_version_number_of_header_files>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_vendor_annotations_vendorannotations")
-- @DocLink("<FMI2_STANDARD> Section 2.2.6, Page 45")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -54,7 +54,7 @@ See <<_definition_of_vendor_annotations_vendorannotations>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_an_fmu_fmimodeldescription")
-- @DocLink("<FMI2_STANDARD> Section 2.2.1, Page 31")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -72,7 +72,7 @@ See <<_definition_of_an_fmu_fmimodeldescription>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_an_fmu_fmimodeldescription")
-- @DocLink("<FMI2_STANDARD> Section 2.2.1, Page 31")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -91,7 +91,7 @@ See <<_definition_of_an_fmu_fmimodeldescription>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_types_typedefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.3, Page 40")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -117,8 +117,8 @@ See <<_definition_of_types_typedefinitions>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_model_variables_modelvariables")
-- @DocLink("<FMI2_STANDARD>#_definition_of_types_typedefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
-- @DocLink("<FMI2_STANDARD> Section 2.2.3, Page 40")
// {vdm}
endif::[]
// {vdm}
Expand Down Expand Up @@ -148,7 +148,7 @@ validVariableTypes(fmd) == allOf
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_types_typedefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.3, Page 40")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -171,7 +171,7 @@ See <<_definition_of_types_typedefinitions>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_model_variables_modelvariables")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
// {vdm}
endif::[]
// {vdm}
Expand Down Expand Up @@ -199,7 +199,7 @@ See <<_definition_of_model_variables_modelvariables>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_model_variables_modelvariables")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
// {vdm}
endif::[]
// {vdm}
Expand Down Expand Up @@ -232,7 +232,7 @@ See <<_definition_of_model_variables_modelvariables>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_types_typedefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.3, Page 40")
// {vdm}
endif::[]
// {vdm}
Expand Down Expand Up @@ -275,7 +275,7 @@ See <<_definition_of_types_typedefinitions>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_model_variables_modelvariables")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -299,7 +299,7 @@ See <<_definition_of_model_variables_modelvariables>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_model_variables_modelvariables")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -324,7 +324,7 @@ See <<_definition_of_model_variables_modelvariables>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#table-variableBase-attributes")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
// {vdm}
endif::[]
// {vdm}
Expand Down Expand Up @@ -356,7 +356,7 @@ See <<table-variableBase-attributes>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_the_model_structure_modelstructure")
-- @DocLink("<FMI2_STANDARD> Section 2.2.8, Page 58")
// {vdm}
endif::[]
// {vdm}
Expand Down Expand Up @@ -394,7 +394,7 @@ See <<_definition_of_the_model_structure_modelstructure>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_the_model_structure_modelstructure")
-- @DocLink("<FMI2_STANDARD> Section 2.2.8, Page 58")
// {vdm}
endif::[]
// {vdm}
Expand Down Expand Up @@ -428,7 +428,7 @@ See <<_definition_of_the_model_structure_modelstructure>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_the_model_structure_modelstructure")
-- @DocLink("<FMI2_STANDARD> Section 2.2.8, Page 58")
// {vdm}
endif::[]
// {vdm}
Expand Down
2 changes: 1 addition & 1 deletion fmi2/rule-model/Rules/LogCategories.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endif::[]
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_log_categories_logcategories")
-- @DocLink("<FMI2_STANDARD> Section 2.2.4, Page 44")
// {vdm}
endif::[]
// {vdm}
Expand Down
4 changes: 2 additions & 2 deletions fmi2/rule-model/Rules/ModelExchange.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endif::[]
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_model_exchange_fmu_modelexchange")
-- @DocLink("<FMI2_STANDARD> Section 3.3.1, Page 94")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -31,7 +31,7 @@ See <<_model_exchange_fmu_modelexchange>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_header_files_and_naming_of_functions")
-- @DocLink("<FMI2_STANDARD> Section 2.1.1, Page 14")
// {vdm}
endif::[]
// {vdm}
Expand Down
2 changes: 1 addition & 1 deletion fmi2/rule-model/Rules/ModelStructure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endif::[]
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_the_model_structure_modelstructure")
-- @DocLink("<FMI2_STANDARD> Section 2.2.8, Page 58")
// {vdm}
endif::[]
// {vdm}
Expand Down
8 changes: 4 additions & 4 deletions fmi2/rule-model/Rules/ModelVariables.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endif::[]
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_model_variables_modelvariables")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
// {vdm}
endif::[]
// {vdm}
Expand Down Expand Up @@ -77,7 +77,7 @@ See <<_definition_of_model_variables_modelvariables>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_model_variables_modelvariables")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -96,7 +96,7 @@ See <<_definition_of_model_variables_modelvariables>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_model_variables_modelvariables")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
// {vdm}
endif::[]
// {vdm}
Expand Down Expand Up @@ -127,7 +127,7 @@ See <<_definition_of_model_variables_modelvariables>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_model_variables_modelvariables")
-- @DocLink("<FMI2_STANDARD> Section 2.2.7, Page 46")
// {vdm}
endif::[]
// {vdm}
Expand Down
8 changes: 4 additions & 4 deletions fmi2/rule-model/Rules/TypeDefinitions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endif::[]
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_types_typedefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.3, Page 40")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -32,7 +32,7 @@ See <<_definition_of_types_typedefinitions>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_types_typedefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.3, Page 40")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -59,7 +59,7 @@ See <<_definition_of_types_typedefinitions>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_types_typedefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.3, Page 40")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -79,7 +79,7 @@ See <<_definition_of_types_typedefinitions>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_types_typedefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.3, Page 40")
// {vdm}
endif::[]
// {vdm}
Expand Down
4 changes: 2 additions & 2 deletions fmi2/rule-model/Rules/UnitDefinitions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endif::[]
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_units_unitdefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.2, Page 35")
// {vdm}
endif::[]
// {vdm}
Expand All @@ -31,7 +31,7 @@ See <<_definition_of_units_unitdefinitions>>
ifdef::hidden[]
// {vdm}

-- @DocLink("<FMI2_STANDARD>#_definition_of_units_unitdefinitions")
-- @DocLink("<FMI2_STANDARD> Section 2.2.2, Page 35")
// {vdm}
endif::[]
// {vdm}
Expand Down
2 changes: 1 addition & 1 deletion fmi2/vdmcheck/src/main/java/VDMCheckPlus.java
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public static void main(String[] args)
File filename = null;
String vdmOUT = null;
String xmlIN = null;
String prefix = "https://fmi-standard.org/docs/3.0/";
String prefix = "https://github.com/modelica/fmi-standard/releases/download/v2.0.4/FMI-Specification-2.0.4.pdf";

for (int a=0; a < args.length; a++)
{
Expand Down
2 changes: 1 addition & 1 deletion fmi2/vdmcheck/src/main/scripts/VDMCheck2.sh
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ fi

if [ -z "$LINK2" ]
then
LINK2="https://fmi-standard.org/docs/2.0/"
LINK2="https://github.com/modelica/fmi-standard/releases/download/v2.0.4/FMI-Specification-2.0.4.pdf"
fi

if [ -z "$LINK3" ]
Expand Down
2 changes: 1 addition & 1 deletion fmi2/vdmcheck/src/test/java/MaestroCheckFMI2Test.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public void test() throws Exception
errors.get(0).message);
Assert.assertTrue(errors.get(0).doclinks != null);
Assert.assertEquals(
"<FMI2_STANDARD>#_definition_of_the_model_structure_modelstructure\n",
"<FMI2_STANDARD> Section 2.2.8, Page 58\n",
errors.get(0).doclinks.get(0).toString());

errors = checker.check(null, build, null);
Expand Down

0 comments on commit 5248c4c

Please sign in to comment.