Generated Model Documentation

Home > Model Development Topics > Generated Model Documentation

This topic describes how to generate stand-alone human-readable reference documentation for a model using the OpenM++ compiler.

This topic is under construction and/or revision.

Related topics

• Model Documentation: Home topic on model documentation
• Authored Model Documentation: The autonomous authored component of model documentation
• Model Languages: The human languages supported by a model
• Model Symbols: Symbols in model code and in the user interface
• Symbol Labels and Notes: Human-language labels and notes for model symbols

Topic contents

• Introduction and outline
• Generating model documentation
• Structure of generated model documentation

This topic is under construction.

Introduction and outline

Human language labels and notes for model symbols can be supplied by a model developer to the OpenM++ compiler, as described in Model Documentation. These labels and notes are published as metadata when a model is built. They are used extensively by the OpenM++ UI to present a human-readable interface in a model's supported languages. That same information, combined with other metadata, can be formatted and published by the OpenM++ compiler as stand-alone reference documentation when the model is built.

This topic first describes how to tell the OpenM++ compiler to produce stand-alone human-readable reference documentation, and where the output is located. This is followed by a description of how the generated output is organized, using RiskPaths as an example.

[back to topic contents]

Generating model documentation

By default, the OpenM++ compiler does not produce stand-alone documentation. The command line option -Omc.ModelDoc or the corresponding ini option can be used to turn it on.

In Visual Studio, the Model project OpenM++ property page contains a selectable option to activate it:

The generated stand-alone documentation, in each of the model's supported languages, is written to files in the folder...

The following table lists each option which can affects the content of the User Edition of the Symbol Reference.

Option	Default	Enabled content
symref_model_symbol	on	Topic for the unique model symbol, if declared in the model
symref_parameters	on	Parameter topics, parameter alphabetic list, parameter hierarchical list, parameter cross-reference sections in other topics
symref_tables	on	Tables
symref_enumerations	on	Individual enumeration topics, enumeration alphabetic list, enumeration cross-reference sections in other topics
symref_global_functions	off	Global function cross-reference sections in other topics
symref_entity_functions	off	Entity function cross-reference sections in other topics
symref_identity_attributes	off	Identity attribute cross-reference sections in other topics
symref_model_modules	off	Module topics for code modules, module cross-reference sections in other topics
symref_use_modules	off	Module topics for use modules, module cross-reference sections in other topics

[back to topic contents]

Structure of generated model documentation

Content to follow.

[back to topic contents]