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
21 # Structured documentation of a `MEntity` object
23 # Raw content, line by line
24 # The starting `#` and first space are stripped.
25 # The trailing `\n` are chomped.
26 var content
= new Array[String]
28 # The entity where the documentation is originally attached to.
29 # This gives some context to resolve identifiers or to run examples.
30 var original_mentity
: nullable MEntity = null is writable
32 # The original location of the doc for error messages
33 var location
: Location
37 # The documentation associated to the entity
38 var mdoc
: nullable MDoc is writable
40 # The documentation associated to the entity or their main nested entity.
42 # MPackage fall-back to their root MGroup
43 # MGroup fall-back to their default_mmodule
44 # Other entities do not fall-back
46 # One may use `MDoc::original_mentity` to retrieve the original
47 # source of the documentation.
48 fun mdoc_or_fallback
: nullable MDoc do return mdoc
50 # Is the entity deprecated?
52 # Used for warnings and in documentation.
53 # Has no other specific effect.
54 var deprecation
: nullable MDeprecationInfo = null is writable
57 # Information about a deprecated entity
58 class MDeprecationInfo
59 # Explanation about the deprecation
60 var mdoc
: nullable MDoc = null is writable