Language Configuration Tab (DATAFLOW Code)
This Guide Article has been written for Version 2.1 of the DATAFLOW Software. For Previous Releases use the version selection in the navigation bar at the top of this page.
This Tab is part of Build Configuration Page in the Project Settings dialog.
Tab Description
The Language Configuration Page in the Build Configuration is used to configure the code generation language for this Build Configuration.
Depending on the language, it is possible to enable or disable language specific features in the generated code.
See the C++ Code Generation article for an overview on code generation.
Tab Actions
This tab does not provide any special actions.
Tab Groups
The page shows the following groups in Advanced mode:
- Language
- C++ (A)
- Static Analysis (A)
- Documentation
For each group, if an option is only shown in advanced mode, it will be marked with (A).
Language Group
Target Language |
This field defines the target language for the code generator. This must be supported by all toolchains used to compile the generated code to avoid compiler errors. |
Custom Constructor Arguments (A) |
This field defines the maximal number of arguments for a custom constructor. The code generator will not generate custom constructors for data types (e.g. protocols) with more fields. |
C++ Group (A)
Generate Directory for Root Namespace (A) |
When this checkbox is checked., the code generator will create a folder for the root namespace. When unchecked, the root namespace is still added to all generated files, but not folder is created. |
Export Types to Global Namespace (A) |
When this checkbox is checked, the code generator will add an using statement to all generated header files for each type defined in this header. This allows to use any generated type from the global namespace. This is not recommendet. It is provided for backwards compatibility reasons because older versions of the Imt.Base packages did require this. Do not enable this for new projects bcause it will lead to the code smell 'global namespace pollution'. |
Use EventIfc in Protocols (A) |
All generated protocols will inherit the EventIfc interface as defined in Imt.Base. |
Public Struct Fields (A) |
All struct fields are generated as public fields when enabled and as private fields (same as for protocols) when disabled. |
Trailing Return Types (C++11) (A) |
This is available for C++11 or newer only. When checked, this will use the trailing return type for all generated methods. |
Static Analysis Group (A)
Static Code Checker Suppression Format (A) |
This field defines the static code checker suppression format to be used. |
Language Rulesets (A) |
This field allows to select all language rule-sets for which the code generator must generate static code checker suppressions. This is a multi select field. To disable generation of suppressions, this field must be empty. |
Static Code Analyzer Excludes
The static code checker suppression configuration options of the code generator are described in the article C++ Static Code Checker Support.
Documentation Group
Documentation Style |
This field defines the format of all generated documentation comments in C++ header files. |
Documentation Style
The documentation style configuration defines the format for documentation comments. Such comments are generated for classes, members and methods based on the element description defined in the DATAFLOW Model.
Javadoc Documentation StyleGenertes documentation commens in the Javadoc format that can be parsed by doxygen. /** |
Qt Documentation StyleGenerates documentation comments in the Qt format that can be parsed by doxygen. /*! |
XML Documentation StyleGenerates documentation comments in XML format that is better suited to be parsed by custom tools. /// <summary> |
Required Module: DATAFLOW Code
This Article has been written based on V2.1.1 of the DATAFLOW software.
Latest update 2023-05-31 by WUM.
Comments
0 comments
Please sign in to leave a comment.