Skip to content

Commit

Permalink
Consistently call it description-string
Browse files Browse the repository at this point in the history
  • Loading branch information
HansOlsson committed Dec 20, 2019
1 parent 498c220 commit 27ab728
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 21 deletions.
4 changes: 2 additions & 2 deletions chapters/classes.tex
Original file line number Diff line number Diff line change
Expand Up @@ -601,8 +601,8 @@ \section{Class Declarations}\doublelabel{class-declarations}
long-class-specifier | short-class-specifier | der-class-specifier

long-class-specifier :
IDENT string-comment composition end IDENT
| extends IDENT [ class-modification ] string-comment composition
IDENT description-string composition end IDENT
| extends IDENT [ class-modification ] description-string composition
end IDENT

short-class-specifier :
Expand Down
2 changes: 1 addition & 1 deletion chapters/functions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1680,7 +1680,7 @@ \section{External Function Interface}\doublelabel{external-function-interface}
The format of an external function declaration is as follows.

\begin{lstlisting}[language=grammar]
function IDENT string-comment
function IDENT description-string
{ component-clause ";" }
[ protected { component-clause ";" } ]
external [ language-specification ] [
Expand Down
8 changes: 4 additions & 4 deletions chapters/inheritance.tex
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ \section{Modifications}\doublelabel{modifications}
\end{lstlisting}

{]}
When present, the description string of a modifier overrides the existing description.
When present, the description-string of a modifier overrides the existing description.

\subsection{Syntax of Modifications and Redeclarations}\doublelabel{syntax-of-modifications-and-redeclarations}

Expand Down Expand Up @@ -442,7 +442,7 @@ \subsection{Merging of Modifications}\doublelabel{merging-of-modifications}
\subsection{Single Modification}\doublelabel{single-modification}

Two arguments of a modification shall not modify the same element,
attribute, or string-comment. When using qualified names the different
attribute, or description-string. When using qualified names the different
qualified names starting with the same identifier are merged into one
modifier. If a modifier with a qualified name has the each or
final-prefix that prefix is only seen as applied to the final part of
Expand Down Expand Up @@ -470,7 +470,7 @@ \subsection{Single Modification}\doublelabel{single-modification}
m1(r=1.5, r=1.6) // Multiple modifier for r (its value)
m1(r=1.5, r=1.5) // Multiple modifier for r (its value) - even if identical
m1(r.start=2, r(start=3)) // Multiple modifier for r.start
m1(x.r=1.5 "x", x.r(start=2.0) "y")) // Multiple string-comment for x.r
m1(x.r=1.5 "x", x.r(start=2.0) "y")) // Multiple description-string for x.r
m1(r=R(), r(y=2)) // Multiple modifier for r.y - both direct value and part of record
\end{lstlisting}
\emph{The following examples are correct:}
Expand Down Expand Up @@ -705,7 +705,7 @@ \subsection{The class extends Redeclaration Mechanism}\doublelabel{the-class-ext
class-specifier : long-class-specifier | ...

long-class-specifier : ...
| extends IDENT [ class-modification ]string-comment composition end IDENT
| extends IDENT [ class-modification ] description-string composition end IDENT
\end{lstlisting}
The nonterminal \lstinline!class-definition! is referenced in several places in the
grammar, including the following case which is used in some examples
Expand Down
9 changes: 4 additions & 5 deletions chapters/lexicalstructure.tex
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,10 @@ \section{Comments}\doublelabel{comments}
*/
\end{lstlisting}

There is also a kind of ``documentation comment,'' really a
\emph{documentation string} that is part of the Modelica language and
therefore not ignored by the Modelica translator. Such ``comments'' may
occur at the ends of declarations, equations, or statements or at the
beginning of class definitions. For example:
There is also a description-string, that is part of the Modelica language and
therefore not ignored by the Modelica translator. Such a description-string may
occur at the end of a declaration, equation, or statement or at the
beginning of a class definition. For example:

\begin{lstlisting}[language=modelica]
model TempResistor "Temperature dependent resistor"
Expand Down
17 changes: 8 additions & 9 deletions chapters/syntax.tex
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,13 @@ \section{Lexical conventions}\doublelabel{lexical-conventions}
has structured comments in the form of annotations and string
comments.
\item
Description strings (= production ``string-comment'' in the grammar)
and strings in annotations (= STRING with production annotation-comment in the
Each description-string or string in annotations (= STRING with production annotation-comment in the
grammar) may contain any member of the Unicode character set. All
other strings have to contain only the sub-set of Unicode characters
identical with the 7-bit US-ASCII character set. {[}\emph{As a
consequence, operators like ``\textgreater{}'' or ``\textless{}'', and
external functions only operate on ASCII strings and not on
Unicode-strings.} \emph{Within a description string the tags
Unicode-strings.} \emph{Within a description-string the tags
\lstinline!<HTML>! and \lstinline!</HTML>! or
\lstinline!<html>! and \lstinline!</html>!
define optionally begin and end of content that is HTML encoded.}{]}
Expand Down Expand Up @@ -97,8 +96,8 @@ \subsection{Class Definition}\doublelabel{class-definition}
long-class-specifier | short-class-specifier | der-class-specifier

long-class-specifier :
IDENT string-comment composition end IDENT
| extends IDENT [ class-modification ] string-comment composition
IDENT description-string composition end IDENT
| extends IDENT [ class-modification ] description-string composition
end IDENT

short-class-specifier :
Expand Down Expand Up @@ -205,7 +204,7 @@ \subsection{Modification}\doublelabel{modification}
[ each ] [ final ] ( element-modification | element-replaceable )

element-modification :
name [ modification ] string-comment
name [ modification ] description-string

element-redeclaration :
redeclare [ each ] [ final ]
Expand Down Expand Up @@ -409,10 +408,10 @@ \subsection{Expressions}\doublelabel{expressions1}
subscript :
":" | expression

comment :
string-comment [ annotation-comment ]
description :
description-string [ annotation-comment ]

string-comment :
description-string :
[ STRING { "+" STRING } ]

annotation-comment :
Expand Down

0 comments on commit 27ab728

Please sign in to comment.