src/model/mdoc.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   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
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   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.
  14
  15 # Documentation of model entities
  16 module mdoc
  17
  18 import model_base
  19 import location
  20
  21 # Structured documentation of a `MEntity` object
  22 class MDoc
  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]
  27
  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
  31
  32         # The original location of the doc for error messages
  33         var location: Location
  34 end
  35
  36 redef class MEntity
  37         # The documentation associated to the entity
  38         var mdoc: nullable MDoc is writable
  39
  40         # The documentation associated to the entity or their main nested entity.
  41         #
  42         # * `MPackage`s fall back to their root `MGroup`.
  43         # * `MGroup`s fall back to their `default_mmodule`.
  44         # * `MClass`es, `MClassDef`s, `MProperty`s and `MPropDef`s fall-back to
  45         #   their introducing definition.
  46         # * `MClassType`s fall back to their wrapped `MClass`.
  47         # * `MVirtualType`s fall back to their wrapped `MProperty`.
  48         # * Other entities do not fall back.
  49         #
  50         # One may use `MDoc::original_mentity` to retrieve the original
  51         # source of the documentation.
  52         fun mdoc_or_fallback: nullable MDoc do return mdoc
  53
  54         # Is the entity deprecated?
  55         #
  56         # Used for warnings and in documentation.
  57         # Has no other specific effect.
  58         var deprecation: nullable MDeprecationInfo = null is writable
  59 end
  60
  61 # Information about a deprecated entity
  62 class MDeprecationInfo
  63         # Explanation about the deprecation
  64         var mdoc: nullable MDoc = null is writable
  65 end