X-Git-Url: http://nitlanguage.org diff --git a/src/doc/doc_base.nit b/src/doc/doc_base.nit index e7f59c0..ce36170 100644 --- a/src/doc/doc_base.nit +++ b/src/doc/doc_base.nit @@ -17,6 +17,7 @@ module doc_base import toolcontext import model_ext +import model::model_views # The model of a Nitdoc documentation. # @@ -25,6 +26,9 @@ import model_ext # 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. # @@ -33,12 +37,6 @@ class DocModel # 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 @@ -74,6 +72,16 @@ class DocPage var root = new DocRoot redef fun to_s do return title + + # Pretty prints the content of this page. + fun pretty_print: Writable do + var res = new Template + res.addn "{class_name} {title}" + for child in root.children do + child.pretty_print_in(res) + end + return res + end end # `DocPage` elements that can be nested in another. @@ -100,6 +108,9 @@ abstract class DocComposite # (HTML links, HTML anchors, vim links, etc.). var id: String is writable + # Item title if any. + var title: nullable String is writable + # Does `self` have a `parent`? fun is_root: Bool do return parent == null @@ -108,8 +119,18 @@ abstract class DocComposite # Children are ordered, this order can be changed by the `DocPhase`. var children = new Array[DocComposite] - # Does `self` have `children`? - fun is_empty: Bool do return children.is_empty + # Is `self` not displayed in the page. + # + # By default, empty elements are hidden. + fun is_hidden: Bool do return children.is_empty + + # Title used in table of content if any. + var toc_title: nullable String is writable, lazy do return title + + # Is `self` hidden in the table of content? + var is_toc_hidden: Bool is writable, lazy do + return toc_title == null or is_hidden + end # Add a `child` to `self`. # @@ -121,9 +142,25 @@ abstract class DocComposite # 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 + + # Pretty prints this composite recursively. + fun pretty_print: Writable do + var res = new Template + pretty_print_in(res) + return res + end + + # Appends the Pretty print of this composite in `res`. + private fun pretty_print_in(res: Template) do + res.add "\t" * depth + res.add "#" * depth + res.addn " {id}" + for child in children do child.pretty_print_in(res) + end end # The `DocComposite` element that contains all the other. @@ -135,6 +172,8 @@ class DocRoot super DocComposite redef var id = "" + redef var title = "" + # No op for `RootSection`. redef fun parent=(p) do end end @@ -181,7 +220,7 @@ 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" @@ -280,6 +319,7 @@ redef class MModule # 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