1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Documentation of model entities
20 # Structured documentation of a `MEntity` object
22 # Raw content, line by line
23 # The starting `#` and first space are stripped.
24 # The trailing `\n` are chomped.
25 var content
= new Array[String]
27 # The entity where the documentation is originally attached to.
28 # This gives some context to resolve identifiers or to run examples.
29 var original_mentity
: nullable MEntity writable = null
33 # The documentation assiciated to the entity
34 var mdoc
: nullable MDoc writable