There are some textual conventions used in this document:
This ClassName
is a class or a module
name.
This Constant
is a constant or a
macro.
This Function
is a function or
method.
This Parameter
is a parameter or a
function/method argument.
This FileName
is a file or a path
name.
Additionally, the following pictograms are used:
Program listings:
{ std::cout << "This is some program code." << std::endl; }
This is a tip or a useful hint:
Tip | |
---|---|
Hey, do it like this! It's better than the other way! |
This is important for understanding and correct programming:
Important | |
---|---|
Look at this stuff! It's really important! |
Try to avoid this or do it carefully:
Warning | |
---|---|
If you do this, you really should know what you do... it could be dangerous otherwise. |
General notes are shown like this:
Note | |
---|---|
This is some interesting additional information. |
In many cases, simplified or artificial words will be used without introducing them explicitly if they are self-explanatory.
© 2024 MeVis Medical Solutions AG