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 = null is writable
33 # The documentation associated to the entity
34 var mdoc
: nullable MDoc is writable
36 # The documentation associated to the entity or their main nested entity.
38 # MProject fall-back to their root MGroup
39 # MGroup fall-back to their default_mmodule
40 # Other entities do not fall-back
42 # One may use `MDoc::original_mentity` to retrieve the original
43 # source of the documentation.
44 fun mdoc_or_fallback
: nullable MDoc do return mdoc
46 # Is the entity deprecated?
48 # Used for warnings and in documentation.
49 # Has no other specific effect.
50 var deprecation
: nullable MDeprecationInfo = null is writable
53 # Information about a deprecated entity
54 class MDeprecationInfo
55 # Explanation about the deprecation
56 var mdoc
: nullable MDoc = null is writable