Define more annotations as declarations

chapters/annotations.tex

@@ -387,8 +387,8 @@ \section{Symbolic Processing}\label{annotations-for-symbolic-processing}\label{s
 \end{center}
 
 \begin{annotationdefinition}[Evaluate]
-\begin{synopsis}[grammar]\begin{lstlisting}
-"Evaluate" "=" ( false | true )
+\begin{synopsis}\begin{lstlisting}
+Boolean Evaluate;
 \end{lstlisting}\end{synopsis}
 \begin{semantics}
 The annotation \lstinline!Evaluate! can occur in the component declaration, its type declaration, or a base class of the type-declaration.
@@ -478,8 +478,8 @@ \section{Simulations}\label{annotations-for-simulations}\label{simulations}
 \end{annotationdefinition}
 
 \begin{annotationdefinition}[HideResult]
-\begin{synopsis}[grammar]\begin{lstlisting}
-"HideResult" "=" ( false | true )
+\begin{synopsis}\begin{lstlisting}
+Boolean HideResult;
 \end{lstlisting}\end{synopsis}
 \begin{semantics}
 \lstinline!HideResult = true! defines that the model developer proposes to not show the simulation results of the corresponding component.
@@ -495,8 +495,10 @@ \section{Simulations}\label{annotations-for-simulations}\label{simulations}
 \end{annotationdefinition}
 
 \begin{annotationdefinition}[TestCase]
-\begin{synopsis}[grammar]\begin{lstlisting}
-"TestCase" "(" "shouldPass" "=" ( false | true ) ")"
+\begin{synopsis}\begin{lstlisting}
+record TestCase
+  Boolean shouldPass;
+end TestCase;
 \end{lstlisting}\end{synopsis}
 \begin{semantics}
 If \lstinline!shouldPass! is \lstinline!false! it indicates that the translation or the simulation of the model should fail.
@@ -518,7 +520,7 @@ \subsection{Single Use of Class}\label{annotation-for-single-use-of-class}\label
 For state machines it is useful to have single instances of local classes.
 This can be done using:
 \begin{lstlisting}[language=modelica]
-annotation(singleInstance = true)
+Boolean singleInstance = true;
 \end{lstlisting}
 
 The annotation \fmtannotationindex{singleInstance} in a class indicates that there should only be one component instance of the class, and it should be in the same scope as the class is defined.
@@ -527,8 +529,8 @@ \subsection{Single Use of Class}\label{annotation-for-single-use-of-class}\label
 \subsection{Connection Restrictions}\label{connection-restrictions}
 
 A connector component declaration may have the following annotation:
-\begin{lstlisting}[language=modelica]
-annotation(mustBeConnected = "message");
+\begin{lstlisting}[language=modelica, mathescape=true]
+String mustBeConnected = "$\mathit{message}$";
 \end{lstlisting}%
 \annotationindex{mustBeConnected}
 
@@ -555,8 +557,8 @@ \subsection{Connection Restrictions}\label{connection-restrictions}
 \end{example}
 
 A connector component declaration may have the following annotation:
-\begin{lstlisting}[language=modelica]
-annotation(mayOnlyConnectOnce = "message");
+\begin{lstlisting}[language=modelica, mathescape=true]
+String mayOnlyConnectOnce = "$\mathit{message}$";
 \end{lstlisting}%
 \annotationindex{mayOnlyConnectOnce}
 
@@ -1254,16 +1256,15 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
 
 This section describes the annotations that are used to define properties of the graphical user interface.
 
-\begin{lstlisting}[language=modelica]
-annotation(preferredView = $\mathit{view}$)
+\begin{lstlisting}[language=modelica, mathescape=true]
+String preferredView = $\mathit{view}$;
 \end{lstlisting}
 
 The \fmtannotationindex{preferredView} annotation defines the default view when selecting the class.
 The $\mathit{view}$ is a \lstinline!String! literal where \lstinline!"info"! means class documentation (``information''), \lstinline!"diagram"! means diagram view, \lstinline!"icon"! means icon view, and \lstinline!"text"! means Modelica source code (``text'').
 
-\begin{lstlisting}[language=grammar]
-  documentation-class-annotation:
-     annotation "(" DocumentationClass "=" true ")"
+\begin{lstlisting}
+Boolean DocumentationClass = true;
 \end{lstlisting}%
 \annotationindex{DocumentationClass}
 
@@ -1275,17 +1276,17 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
 of the class names, and if no icon is defined, a special information default icon may be displayed in the package browser.
 \end{nonnormative}
 
-\begin{lstlisting}[language=modelica]
- annotation(defaultComponentName = "name")
+\begin{lstlisting}[language=modelica, mathescape=true]
+String defaultComponentName = "$\mathit{name}$";
 \end{lstlisting}%
 \annotationindex{defaultComponentName}
 
 When creating a component of the given class, the recommended component name is \emph{name}.
 If the default name cannot be used (e.g., since it is already in use), another name based on \lstinline!defaultComponentName! shall be derived automatically, except as described under \lstinline!defaultComponentPrefixes!.
 When automatically deriving a name, any trailing `\lstinline!1!' in the \lstinline!defaultComponentName! shall be disregarded.
 
-\begin{lstlisting}[language=modelica]
-annotation(defaultComponentPrefixes = "prefixes")
+\begin{lstlisting}[language=modelica, mathescape=true]
+String defaultComponentPrefixes = "$\mathit{prefixes}$";
 \end{lstlisting}%
 \annotationindex{defaultComponentPrefixes}
 
@@ -1303,8 +1304,8 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
 and the default name cannot be used (e.g., since it is already in use) it is recommended to give a diagnostic.
 \end{nonnormative}
 
-\begin{lstlisting}[language=modelica]
-annotation(missingInnerMessage = "message")
+\begin{lstlisting}[language=modelica, mathescape=true]
+String missingInnerMessage = "$\mathit{message}$";
 \end{lstlisting}%
 \annotationindex{missingInnerMessage}
 
@@ -1330,7 +1331,7 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
 
 A simple type or component of a simple type may have:
 \begin{lstlisting}[language=modelica]
-annotation(absoluteValue = false);
+Boolean absoluteValue;
 \end{lstlisting}%
 \annotationindex{absoluteValue}
 
@@ -1343,7 +1344,7 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
 
 A model or block definition may contain:
 \begin{lstlisting}[language=modelica]
-annotation(defaultConnectionStructurallyInconsistent = true)
+Boolean defaultConnectionStructurallyInconsistent;
 \end{lstlisting}%
 \annotationindex{defaultConnectionStructurallyInconsistent}
 
@@ -1357,8 +1358,8 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
 \end{nonnormative}
 
 A class may have the following annotation:
-\begin{lstlisting}[language=modelica]
-annotation(obsolete = "message");
+\begin{lstlisting}[language=modelica, mathescape=true]
+String obsolete = "$\mathit{message}$";
 \end{lstlisting}%
 \annotationindex{obsolete}
 
@@ -1367,12 +1368,12 @@ \section{Graphical User Interface}\label{annotations-for-the-graphical-user-inte
 If that is not possible the current class can have also have an \lstinline!obsolete! annotation.
 
 A component declaration may have the following annotation:
-\begin{lstlisting}[language=modelica]
-annotation(unassignedMessage = "message");
+\begin{lstlisting}[language=modelica, mathescape=true]
+String unassignedMessage = "$\mathit{message}$";
 \end{lstlisting}%
 \annotationindex{unassignedMessage}
 
-When the variable to which this annotation is attached in the declaration cannot be computed due to the structure of the equations, the string \lstinline!"message"! can be used as a diagnostic message.
+When the variable to which this annotation is attached in the declaration cannot be computed due to the structure of the equations, the string \lstinline!"$\mathit{message}$"! can be used as a diagnostic message.
 
 \begin{nonnormative}
 When using BLT partitioning, this means if a variable \lstinline!a! or one of its aliases \lstinline!b = a! or \lstinline!b = -a!