Skip to content

Commit

Permalink
AvoidStartingWithAnnotation
Browse files Browse the repository at this point in the history
  • Loading branch information
HansOlsson committed Jan 12, 2022
1 parent 308f82a commit 06179f5
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions chapters/annotations.tex
Expand Up @@ -34,7 +34,7 @@ \section{Vendor-Specific Annotations}\label{vendor-specific-annotations}
vendor-specific annotations.
\end{example}

\section{Annotations for Documentation}\label{annotations-for-documentation}
\section{Documentation}\label{annotations-for-documentation}\label{documentation}

The \fmtannotationindex{Documentation} annotation has the following contents, where the \lstinline!info! and \lstinline!revisions! annotations are described in \cref{annotation-info-revisions}, and the \lstinline!figures! annotation is described in \cref{annotations-for-figures}:
\begin{lstlisting}[language=modelica]
Expand Down Expand Up @@ -72,7 +72,7 @@ \subsection{Class Description and Revision History}\label{annotation-info-revisi
<a href="modelica://MultiBody.Joints.Revolute#info">Revolute</a>
\end{lstlisting}

\subsection{Annotations for Figures}\label{annotations-for-figures}
\subsection{Figures}\label{annotations-for-figures}\label{figures}

Inside the \lstinline!Documentation! annotation, each element of the \lstinline!figures! annotation array has the following content:
\begin{lstlisting}[language=modelica]
Expand Down Expand Up @@ -343,7 +343,7 @@ \subsubsection{Text Markup in Captions}\label{text-markup-in-captions}
In a similar way, vendor-specific markup can be used to prototype a link for future inclusion in the link markup (either by extending the meaning of Modelica URIs, or by introducing another pseudo-scheme similar to \lstinline!variable:!). This is an example where the vendor-specific markup could make use of the $\mathit{text}$ (for link text) together with the vendor-specific $\mathit{data}$ (describing the actual link).
\end{example}

\section{Annotations for Symbolic Processing}\label{annotations-for-symbolic-processing}
\section{Symbolic Processing}\label{annotations-for-symbolic-processing}\label{symbolic-processing}

The annotation listed below, in addition to annotations described in \crefrange{derivatives-and-inverses-of-functions}{function-inlining-and-event-generation}, can influence the symbolic processing.
\begin{center}
Expand Down Expand Up @@ -378,7 +378,7 @@ \section{Annotations for Symbolic Processing}\label{annotations-for-symbolic-pro
\end{annotationdefinition}


\section{Annotations for Simulations}\label{annotations-for-simulations}
\section{Simulations}\label{annotations-for-simulations}\label{simulations}

The annotations listed below define how models can be checked, translated, and simulated.
\begin{center}
Expand Down Expand Up @@ -447,7 +447,7 @@ \section{Annotations for Simulations}\label{annotations-for-simulations}
\end{annotationdefinition}


\section{Annotation for Single Use of Class}\label{annotation-for-single-use-of-class}
\section{Single Use of Class}\label{annotation-for-single-use-of-class}\label{single-use-of-class}

For state machines it is useful to have single instances of local classes.
This can be done using:
Expand All @@ -459,7 +459,7 @@ \section{Annotation for Single Use of Class}\label{annotation-for-single-use-of-
The intent is to remove the class when the component is removed and to prevent duplication of the component.


\section{Annotations for Graphical Objects}\label{annotations-for-graphical-objects}
\section{Graphical Objects}\label{annotations-for-graphical-objects}\label{graphical-objects}

A graphical representation of a class consists of two abstraction
layers, icon layer and diagram layer showing graphical objects,
Expand Down Expand Up @@ -1125,7 +1125,7 @@ \subsubsection{Edit input}\label{edit-input}
end OnMouseDownEditString;
\end{lstlisting}

\section{Annotations for the Graphical User Interface}\label{annotations-for-the-graphical-user-interface}
\section{Graphical User Interface}\label{annotations-for-the-graphical-user-interface}\label{graphical-user-interface}

This section describes the annotations that are used to define properties of the graphical user interface.

Expand Down Expand Up @@ -1489,7 +1489,7 @@ \subsection{Connector Sizing}\label{connector-sizing}
\end{lstlisting}
\end{nonnormative}

\section{Annotations for Version Handling}\label{annotations-for-version-handling}
\section{Versions}\label{annotations-for-version-handling}\label{versions}

A top-level package or model can specify the version of top-level
classes it uses, its own version number, and if possible how to convert
Expand Down Expand Up @@ -1906,7 +1906,7 @@ \subsection{Version Date and Build Information}\label{version-date-and-build-inf
It is recommended that tools do not automatically store \lstinline!versionBuild! and \lstinline!dateModified! in the \lstinline!uses! annotation.
\end{nonnormative}

\section{Annotations for Access Control to Protect Intellectual Property}\label{annotations-for-access-control-to-protect-intellectual-property}
\section{Access Control to Protect Intellectual Property}\label{annotations-for-access-control-to-protect-intellectual-property}\label{access-control-to-protect-intellectual-property}

This section presents annotations to define the protection and the
licensing of packages. The goal is to unify basic mechanisms to control
Expand Down Expand Up @@ -2169,11 +2169,11 @@ \subsection{Licensing}\label{licensing}
\end{example}


\section{Annotations for Functions}\label{annotations-for-functions}
\section{Functions}\label{annotations-for-functions}

See \crefnameref{derivatives-and-inverses-of-functions}, \crefnameref{function-inlining-and-event-generation}, and \crefnameref{annotations-for-external-libraries-and-include-files}.


\section{Annotation Choices for Modifications and Redeclarations}\label{annotation-choices-for-modifications-and-redeclarations}
\section{Choices for Modifications and Redeclarations}\label{annotation-choices-for-modifications-and-redeclarations}\label{choices-for-modifications-and-redeclarations}

See \crefnameref{annotation-choices-for-suggested-redeclarations-and-modifications}.

0 comments on commit 06179f5

Please sign in to comment.