From: Alexandre Terrasa Date: Tue, 26 May 2015 21:31:22 +0000 (-0400) Subject: nitdoc: introduce `DocComposite::is_hidden` services in `doc_base` X-Git-Tag: v0.7.5~10^2~10 X-Git-Url: http://nitlanguage.org?ds=sidebyside nitdoc: introduce `DocComposite::is_hidden` services in `doc_base` Signed-off-by: Alexandre Terrasa --- diff --git a/src/doc/doc_base.nit b/src/doc/doc_base.nit index e198e70..95ad145 100644 --- a/src/doc/doc_base.nit +++ b/src/doc/doc_base.nit @@ -121,8 +121,10 @@ 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 diff --git a/src/doc/doc_phases/doc_graphs.nit b/src/doc/doc_phases/doc_graphs.nit index 12bf6c2..a0a8d11 100644 --- a/src/doc/doc_phases/doc_graphs.nit +++ b/src/doc/doc_phases/doc_graphs.nit @@ -124,5 +124,5 @@ class GraphArticle # Dot script of the graph. var dot: Text - redef var is_empty = false + redef var is_hidden = false end diff --git a/src/doc/doc_phases/doc_hierarchies.nit b/src/doc/doc_phases/doc_hierarchies.nit index ecd6c74..a543c46 100644 --- a/src/doc/doc_phases/doc_hierarchies.nit +++ b/src/doc/doc_phases/doc_hierarchies.nit @@ -96,4 +96,6 @@ class HierarchyListArticle # MEntities to display in this list. var mentities: Array[MEntity] + + redef fun is_hidden do return mentities.is_empty end diff --git a/src/doc/doc_phases/doc_intros_redefs.nit b/src/doc/doc_phases/doc_intros_redefs.nit index df738c4..1680883 100644 --- a/src/doc/doc_phases/doc_intros_redefs.nit +++ b/src/doc/doc_phases/doc_intros_redefs.nit @@ -99,4 +99,6 @@ class IntrosRedefsListArticle # Intro mentities to list. var mentities: Array[MEntity] + + redef fun is_hidden do return mentities.is_empty end diff --git a/src/doc/doc_phases/doc_lin.nit b/src/doc/doc_phases/doc_lin.nit index 647eaee..c309db8 100644 --- a/src/doc/doc_phases/doc_lin.nit +++ b/src/doc/doc_phases/doc_lin.nit @@ -99,4 +99,5 @@ class DefinitionLinArticle var mentities: Array[MEntity] redef var toc_title = "Linearization" + redef fun is_hidden do return mentities.is_empty end diff --git a/src/doc/doc_phases/doc_structure.nit b/src/doc/doc_phases/doc_structure.nit index 690e5c9..bab950e 100644 --- a/src/doc/doc_phases/doc_structure.nit +++ b/src/doc/doc_phases/doc_structure.nit @@ -342,6 +342,8 @@ end class IntroArticle super MEntityComposite super DocArticle + + redef var is_hidden = false end # An article that display a ConcernsTreee as a list. @@ -350,6 +352,8 @@ class ConcernsArticle # Concerns to list in this article. var concerns: ConcernsTree + + redef fun is_hidden do return concerns.is_empty end # An article that displaus a list of definition belonging to a MEntity. @@ -361,6 +365,8 @@ end # An article that display the definition text of a MEntity. class DefinitionArticle super MEntityArticle + + redef var is_hidden = false end # The main project article. @@ -385,4 +391,8 @@ class IndexArticle # List of mproperties to display. var mprops: Array[MProperty] + + redef fun is_hidden do + return mmodules.is_empty and mclasses.is_empty and mprops.is_empty + end end diff --git a/src/doc/html_templates/html_templates.nit b/src/doc/html_templates/html_templates.nit index 1a5a17c..21ec7c1 100644 --- a/src/doc/html_templates/html_templates.nit +++ b/src/doc/html_templates/html_templates.nit @@ -286,11 +286,6 @@ redef class DocComposite # Level for HTML heading. private fun hlvl: Int do return depth - # Is `self` not displayed in the page. - # - # By default, empty elements are hidden. - fun is_hidden: Bool do return is_empty - # A short, undecorated title that goes in the table of contents. # # By default, returns `html_title.to_s`, subclasses should redefine it. @@ -397,9 +392,6 @@ end redef class IndexArticle redef var html_title = "Index" - redef fun is_empty do - return mmodules.is_empty and mclasses.is_empty and mprops.is_empty - end redef fun render_body do addn "
" @@ -450,12 +442,12 @@ end redef class ConstructorsSection redef var html_title = "Constructors" redef var html_subtitle = null - redef fun is_toc_hidden do return is_empty + redef fun is_toc_hidden do return is_hidden end redef class ConcernSection redef var html_title is lazy do return "in {mentity.nitdoc_name}" - redef fun is_toc_hidden do return is_empty + redef fun is_toc_hidden do return is_hidden end redef class ImportationListSection @@ -468,7 +460,6 @@ end redef class IntroArticle redef var html_title = null - redef var is_hidden = false redef var is_toc_hidden = true # Link to source to display if any. @@ -495,7 +486,6 @@ end redef class ConcernsArticle redef var html_title = "Concerns" - redef fun is_hidden do return concerns.is_empty redef fun render_body do add concerns.html_list end @@ -514,7 +504,6 @@ end redef class DefinitionArticle redef var html_title is lazy do return mentity.html_name redef var html_subtitle is lazy do return mentity.html_declaration - redef var is_hidden = false # Does `self` display only it's title and no body? # @@ -556,7 +545,6 @@ redef class DefinitionArticle end redef class HierarchyListArticle - redef fun is_empty do return mentities.is_empty redef var is_toc_hidden = true redef fun render_body do @@ -577,7 +565,6 @@ redef class IntrosRedefsSection end redef class IntrosRedefsListArticle - redef fun is_hidden do return mentities.is_empty redef var is_toc_hidden = true redef fun render_body do @@ -592,7 +579,6 @@ end redef class DefinitionLinArticle redef var html_title is lazy do return "Linearization" - redef fun is_hidden do return mentities.is_empty redef var is_toc_hidden = true redef fun render_body do @@ -617,7 +603,6 @@ end redef class GraphArticle redef var html_title = null - redef var is_hidden = false redef var is_toc_hidden = true # HTML map used to display link.