Skip to content

Commit

Permalink
Add text for top-level classes as well.
Browse files Browse the repository at this point in the history
  • Loading branch information
HansOlsson committed Sep 12, 2023
1 parent 6af11bb commit feca9b1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions chapters/annotations.tex
Expand Up @@ -2323,6 +2323,12 @@ \subsection{Licensing}\label{licensing}
\end{lstlisting}
\end{example}

\section{License Texts}\label{license-texts}
For a top-level class the {\lstinline!annotation(License="modelica:/ModelicaLibraryName/Resources/Licenses/MyLicense.txt")!}\annotationindex{License}, gives the license files for the class.
The annotation may give a scalar value or an array of values.
The license files are human-readable files containing the license conditions.
External functions may also contain this annotation (with similar contents), see \cref{annotations-for-external-libraries-and-include-files}.
When generating a distributable version for a translated model the license files for used functions and top-level classes should be included.

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

Expand Down
2 changes: 1 addition & 1 deletion chapters/functions.tex
Expand Up @@ -2401,7 +2401,7 @@ \subsection{Annotations for External Functions}\label{annotations-for-external-l
\item
The {\lstinline!annotation(License="modelica:/ModelicaLibraryName/Resources/Licenses/MyLicense.txt")!}\annotationindex{License}, gives the license files for the function.
The license files are human-readable files containing the license conditions.
Top-level classes may also contain this annotation (with similar contents).
Top-level classes may also contain this annotation (with similar contents), see \cref{license-texts}.
When generating a distributable version for a translated model the license files for used functions and top-level classes should be included.
\end{itemize}

Expand Down

0 comments on commit feca9b1

Please sign in to comment.