import toolcontext
import model_ext
+import model::model_views
# The model of a Nitdoc documentation.
#
# The model is populated through `DocPhase` to be constructed.
# It is a placeholder to share data between each phase.
class DocModel
+ super ModelView
+
+ autoinit model, mainmodule, filter
# `DocPage` composing the documentation associated to their ids.
#
# See `add_page`.
var pages: Map[String, DocPage] = new HashMap[String, DocPage]
- # Nit `Model` from which we extract the documentation.
- var model: Model is writable
-
- # The entry point of the `model`.
- var mainmodule: MModule is writable
-
# Add a `page` to this documentation.
fun add_page(page: DocPage) do
if pages.has_key(page.id) then
# Depth of `self` in the composite tree.
fun depth: Int do
+ var parent = self.parent
if parent == null then return 0
return parent.depth + 1
end
redef class ToolContext
# Directory where the Nitdoc is rendered.
- var opt_dir = new OptionString("output directory", "-d", "--dir")
+ var opt_dir = new OptionString("Output directory", "-d", "--dir")
# Shortcut for `opt_dir.value` with default "doc".
var output_dir: String is lazy do return opt_dir.value or else "doc"
# Avoid id conflict with group
redef fun nitdoc_id do
+ var mgroup = self.mgroup
if mgroup == null then return super
return "{mgroup.full_name}::{full_name}".to_cmangle
end