From e34ad0ea93451541eb6022618be628d77fa379ad Mon Sep 17 00:00:00 2001
From: HOS <Hans.Olsson@3ds.com>
Date: Fri, 29 Nov 2024 10:10:25 +0100
Subject: [PATCH 1/2] Start clearing up annotation syntax for functions.

---
 chapters/functions.tex | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/chapters/functions.tex b/chapters/functions.tex
index 87bf5a57b..8bf87d1e3 100644
--- a/chapters/functions.tex
+++ b/chapters/functions.tex
@@ -1670,6 +1670,7 @@ \subsection{Using the Inverse Annotation}\label{using-the-inverse-annotation}
 \section{Function Inlining and Event Generation}\label{function-inlining-and-event-generation}
 
 The annotations listed below affect inlining of functions and the related topic of event generation inside functions.
+For the semantics of the annotations see \cref{notation-for-annotation-definitions}.
 \begin{center}
 \begin{tabular}{l|l l}
 \hline
@@ -1689,8 +1690,8 @@ \section{Function Inlining and Event Generation}\label{function-inlining-and-eve
 Hence, one needs to find the right balance between inlining too early (loss of provided derivatives and inverses) and too late (earlier stages of symbolic processing cannot benefit from symbolic simplifications).
 
 \begin{annotationdefinition}[Inline]
-\begin{synopsis}[grammar]\begin{lstlisting}
-"Inline" "=" ( false | true )
+\begin{synopsis}\begin{lstlisting}
+/*literal*/ constant Boolean Inline;
 \end{lstlisting}\end{synopsis}
 \begin{semantics}
 Has only an effect within a function declaration.
@@ -1700,6 +1701,8 @@ \section{Function Inlining and Event Generation}\label{function-inlining-and-eve
 
 If {\lstinline!Inline = false!}, the model developer proposes to not inline the function.
 
+The default for inlining is tool-specific.
+
 \begin{nonnormative}
 {\lstinline!Inline = true!} is for example used in {\lstinline!Modelica.Mechanics.MultiBody.Frames!} and in functions of {\lstinline!Modelica.Media!} to have no overhead for function calls such as resolving a vector in a different coordinate system and at the same time the function can be analytically differentiated, e.g., for index reduction needed for mechanical systems.
 \end{nonnormative}
@@ -1707,8 +1710,8 @@ \section{Function Inlining and Event Generation}\label{function-inlining-and-eve
 \end{annotationdefinition}
 
 \begin{annotationdefinition}[LateInline]
-\begin{synopsis}[grammar]\begin{lstlisting}
-"LateInline" "=" ( false | true )
+\begin{synopsis}\begin{lstlisting}
+/*literal*/ constant Boolean LateInline = false;
 \end{lstlisting}\end{synopsis}
 \begin{semantics}
 Has only an effect within a function declaration.
@@ -1735,8 +1738,8 @@ \section{Function Inlining and Event Generation}\label{function-inlining-and-eve
 \end{annotationdefinition}
 
 \begin{annotationdefinition}[InlineAfterIndexReduction]
-\begin{synopsis}[grammar]\begin{lstlisting}
-"InlineAfterIndexReduction" "=" ( false | true )
+\begin{synopsis}\begin{lstlisting}
+/*literal*/ constant Boolean InlineAfterIndexReduction = false;
 \end{lstlisting}\end{synopsis}
 \begin{semantics}
 Has only an effect within a function declaration.
@@ -1747,8 +1750,8 @@ \section{Function Inlining and Event Generation}\label{function-inlining-and-eve
 \end{annotationdefinition}
 
 \begin{annotationdefinition}[GenerateEvents]
-\begin{synopsis}[grammar]\begin{lstlisting}
-"GenerateEvents" "=" ( false | true )
+\begin{synopsis}\begin{lstlisting}
+/*literal*/ constant Boolean GenerateEvents = false;
 \end{lstlisting}\end{synopsis}
 \begin{semantics}
 Has only an effect within a function declaration.

From 3f1bc072d109189abcc535f925342989af8411ad Mon Sep 17 00:00:00 2001
From: Hans Olsson <HansOlsson@users.noreply.github.com>
Date: Mon, 9 Dec 2024 09:32:46 +0100
Subject: [PATCH 2/2] Apply suggestions from code review

Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
---
 chapters/functions.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/chapters/functions.tex b/chapters/functions.tex
index 8bf87d1e3..a5d6a8b4c 100644
--- a/chapters/functions.tex
+++ b/chapters/functions.tex
@@ -1670,7 +1670,7 @@ \subsection{Using the Inverse Annotation}\label{using-the-inverse-annotation}
 \section{Function Inlining and Event Generation}\label{function-inlining-and-event-generation}
 
 The annotations listed below affect inlining of functions and the related topic of event generation inside functions.
-For the semantics of the annotations see \cref{notation-for-annotation-definitions}.
+See \cref{notation-for-annotation-definitions} regarding the notation used to describe the annotations.
 \begin{center}
 \begin{tabular}{l|l l}
 \hline