model: add module `model/mdoc` to attach optional MDoc to model entities

Signed-off-by: Jean Privat <jean@pryen.org>

diff --git a/src/model/mdoc.nit b/src/model/mdoc.nit
new file mode 100644 (file)
index 0000000..919b48c
--- /dev/null
+++ b/src/model/mdoc.nit
@@ -0,0 +1,31 @@
+# This file is part of NIT ( http://www.nitlanguage.org ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Documentation of model entities
+module mdoc
+
+import model_base
+
+# Structured documentation of a `MEntity` object
+class MDoc
+       # Raw content, line by line
+       # The starting `#` and first space are stripped.
+       # The trailing `\n` are chomped.
+       var content = new Array[String]
+end
+
+redef class MEntity
+       # The documentation assiciated to the entity
+       var mdoc: nullable MDoc writable
+end

diff --git a/src/model/model.nit b/src/model/model.nit
index 7af7656..79fee97 100644 (file)
--- a/src/model/model.nit
+++ b/src/model/model.nit
@@ -32,6 +32,7 @@ module model
 import poset
 import location
 import mmodule
+import mdoc
 private import more_collections
 
 redef class Model