X-Git-Url: http://nitlanguage.org diff --git a/src/doc/doc_pages.nit b/src/doc/doc_pages.nit index 9c38d44..73ae262 100644 --- a/src/doc/doc_pages.nit +++ b/src/doc/doc_pages.nit @@ -163,6 +163,7 @@ class Nitdoc private fun classes do for mclass in model.mclasses do + if mclass.visibility <= ctx.min_visibility then continue var page = new NitdocClass(ctx, model, mainmodule, mclass) page.render.write_to_file("{ctx.output_dir.to_s}/{page.page_url}") end @@ -170,6 +171,7 @@ class Nitdoc private fun properties do for mproperty in model.mproperties do + if mproperty.visibility <= ctx.min_visibility then continue var page = new NitdocProperty(ctx, model, mainmodule, mproperty) page.render.write_to_file("{ctx.output_dir.to_s}/{page.page_url}") end @@ -231,7 +233,9 @@ class QuickSearch tpl.add "\"{mproperty}\":[" for mpropdef in mprops do var full_name = mpropdef.mclassdef.mclass.full_name - tpl.add "\{txt:\"{full_name}\",url:\"{mpropdef.nitdoc_url}\"\}," + var cls_url = mpropdef.mclassdef.mclass.nitdoc_url + var def_url = "{cls_url}#{mpropdef.mproperty.nitdoc_id}" + tpl.add "\{txt:\"{full_name}\",url:\"{def_url}\"\}," end tpl.add "]," end @@ -350,7 +354,10 @@ abstract class NitdocPage do if location == null then return null var source = ctx.opt_source.value - if source == null then return location.file.filename.simplify_path + if source == null then + var url = location.file.filename.simplify_path + return "View Source" + end # THIS IS JUST UGLY ! (but there is no replace yet) var x = source.split_with("%f") source = x.join(location.file.filename.simplify_path) @@ -463,28 +470,72 @@ abstract class NitdocPage end # MProp description template - fun tpl_mprop_article(mproperty: MProperty, mpropdefs: Array[MPropDef]): TplArticle do - var article = mproperty.tpl_article - if not mpropdefs.has(mproperty.intro) then - # add intro synopsys - var intro_article = mproperty.intro.tpl_short_article - intro_article.source_link = tpl_showsource(mproperty.intro.location) - article.add_child intro_article + # + # `main_mpropdef`: The most important mpropdef to display + # `local_mpropdefs`: List of other locally defined mpropdefs to display + # `lin`: full linearization from local_mpropdefs to intro (displayed in redef tree) + fun tpl_mprop_article(main_mpropdef: MPropDef, local_mpropdefs: Array[MPropDef], + lin: Array[MPropDef]): TplArticle do + var mprop = main_mpropdef.mproperty + var article = new TplArticle(mprop.nitdoc_id) + var title = new Template + title.add mprop.tpl_icon + title.add "" + if main_mpropdef.is_intro then + title.add mprop.tpl_link + title.add mprop.intro.tpl_signature + else + var cls_url = mprop.intro.mclassdef.mclass.nitdoc_url + var def_url = "{cls_url}#{mprop.nitdoc_id}" + var lnk = new TplLink.with_title(def_url, mprop.name, "Go to introduction") + title.add "redef " + title.add lnk + end + article.title = title + article.title_classes.add "signature" + article.summary_title = "{mprop.nitdoc_name}" + article.subtitle = main_mpropdef.tpl_namespace + if main_mpropdef.mdoc != null then + article.content = main_mpropdef.mdoc.tpl_comment + end + var subarticle = new TplArticle("{main_mpropdef.nitdoc_id}_redefs") + # Add redef in same `MClass` + if local_mpropdefs.length > 1 then + for mpropdef in local_mpropdefs do + if mpropdef == main_mpropdef then continue + var redef_article = new TplArticle("{mpropdef.nitdoc_id}") + var redef_title = new Template + redef_title.add "also redef in " + redef_title.add mpropdef.tpl_namespace + redef_article.title = redef_title + redef_article.title_classes.add "signature info" + redef_article.css_classes.add "nospace" + var redef_content = new Template + if mpropdef.mdoc != null then + redef_content.add mpropdef.mdoc.tpl_comment + end + redef_article.content = redef_content + subarticle.add_child redef_article + end end - mainmodule.linearize_mpropdefs(mpropdefs) - for mpropdef in mpropdefs do - # add mpropdef description - var redef_article = mpropdef.tpl_article - redef_article.source_link = tpl_showsource(mpropdef.location) - article.add_child redef_article + # Add linearization + if lin.length > 1 then + var lin_article = new TplArticle("{main_mpropdef.nitdoc_id}_lin") + lin_article.title = "Inheritance" + var lst = new TplList.with_classes(["list-unstyled", "list-labeled"]) + for mpropdef in lin do + lst.add_li mpropdef.tpl_inheritance_item + end + lin_article.content = lst + subarticle.add_child lin_article end + article.add_child subarticle return article end # MProperty description template fun tpl_mpropdef_article(mpropdef: MPropDef): TplArticle do var article = mpropdef.tpl_article - if mpropdef.is_intro then article.content = null article.source_link = tpl_showsource(mpropdef.location) return article end @@ -1052,10 +1103,14 @@ class NitdocClass var classes = mprop.intro.tpl_css_classes.to_a if not mprops2mdefs.has_key(mprop) then classes.add "inherit" - var lnk = new Template - lnk.add new TplLabel.with_classes(classes) - lnk.add mprop.intro.tpl_link - return new TplListItem.with_content(lnk) + var cls_url = mprop.intro.mclassdef.mclass.nitdoc_url + var def_url = "{cls_url}#{mprop.nitdoc_id}" + var lnk = new TplLink(def_url, mprop.name) + if mprop.intro.mdoc != null then lnk.title = mprop.intro.mdoc.short_comment + var item = new Template + item.add new TplLabel.with_classes(classes) + item.add lnk + return new TplListItem.with_content(item) end var defs = mprops2mdefs[mprop] if defs.has(mprop.intro) then @@ -1065,7 +1120,7 @@ class NitdocClass end var lnk = new Template lnk.add new TplLabel.with_classes(classes) - lnk.add mprop.intro.tpl_anchor + lnk.add mprop.tpl_anchor return new TplListItem.with_content(lnk) end @@ -1131,8 +1186,8 @@ class NitdocClass var mclasses = new HashSet[MClass] mclasses.add_all hancestors mclasses.add_all hparents - if hchildren.length < 10 then mclasses.add_all hchildren - if hdescendants.length < 10 then mclasses.add_all hdescendants + mclasses.add_all hchildren + mclasses.add_all hdescendants mclasses.add mclass var graph = tpl_dot(mclasses) if graph != null then section.add_child graph @@ -1152,14 +1207,14 @@ class NitdocClass end # children - if not hchildren.is_empty and hchildren.length < 15 then + if not hchildren.is_empty then var lst = hchildren.to_a name_sorter.sort lst section.add_child tpl_list("children", "Children", lst) end # descendants - if not hdescendants.is_empty and hchildren.length < 15 then + if not hdescendants.is_empty then var lst = hdescendants.to_a name_sorter.sort lst section.add_child tpl_list("descendants", "Descendants", lst) @@ -1170,9 +1225,18 @@ class NitdocClass private fun tpl_list(id: String, title: String, elts: Array[MClass]): TplArticle do var article = new TplArticle.with_title(id, title) - var list = new TplList.with_classes(["list-unstyled", "list-definition"]) - for elt in elts do list.elts.add elt.tpl_list_item - article.content = list + if elts.length > 20 then + var tpl = new Template + for e in elts do + tpl.add e.tpl_link + if e != elts.last then tpl.add ", " + end + article.content = tpl + else + var list = new TplList.with_classes(["list-unstyled", "list-definition"]) + for elt in elts do list.elts.add elt.tpl_list_item + article.content = list + end return article end @@ -1196,33 +1260,48 @@ class NitdocClass var kind_map = sort_by_kind(mprops) # virtual types - var elts = kind_map["type"].to_a - name_sorter.sort(elts) - for elt in elts do - var defs = mprops2mdefs[elt].to_a - section.add_child tpl_mprop_article(elt, defs) + for article in tpl_mproperty_articles(kind_map, "type") do + section.add_child article end - # constructors - elts = kind_map["init"].to_a - name_sorter.sort(elts) - for elt in elts do - var defs = mprops2mdefs[elt].to_a - section.add_child tpl_mprop_article(elt, defs) + for article in tpl_mproperty_articles(kind_map, "init") do + section.add_child article end - # methods - elts = kind_map["fun"].to_a - name_sorter.sort(elts) - for elt in elts do - var defs = mprops2mdefs[elt].to_a - section.add_child tpl_mprop_article(elt, defs) + for article in tpl_mproperty_articles(kind_map, "fun") do + section.add_child article end parent.add_child section end end end + private fun tpl_mproperty_articles(kind_map: Map[String, Set[MProperty]], + kind_name: String): Sequence[TplArticle] do + var articles = new List[TplArticle] + var elts = kind_map[kind_name].to_a + name_sorter.sort(elts) + for elt in elts do + var local_defs = mprops2mdefs[elt] + # var all_defs = elt.mpropdefs + var all_defs = new HashSet[MPropDef] + for local_def in local_defs do + all_defs.add local_def + var mpropdef = local_def + while not mpropdef.is_intro do + mpropdef = mpropdef.lookup_next_definition(mainmodule, mpropdef.mclassdef.bound_mtype) + all_defs.add mpropdef + end + end + var loc_lin = local_defs.to_a + mainmodule.linearize_mpropdefs(loc_lin) + var all_lin = all_defs.to_a + mainmodule.linearize_mpropdefs(all_lin) + articles.add tpl_mprop_article(loc_lin.first, loc_lin, all_lin) + end + return articles + end + redef fun tpl_content do tpl_sidebar_properties var top = tpl_intro @@ -1305,6 +1384,7 @@ class NitdocClass for mclass in mclasses do poset.add_node mclass for oclass in mclasses do + if mclass == oclass then continue poset.add_node oclass if mclass.in_hierarchy(mainmodule) < oclass then poset.add_edge(mclass, oclass) @@ -1315,14 +1395,28 @@ class NitdocClass var op = new FlatBuffer var name = "dep_{mclass.name}" op.append("digraph {name} \{ rankdir=BT; node[shape=none,margin=0,width=0,height=0,fontsize=10]; edge[dir=none,color=gray]; ranksep=0.2; nodesep=0.1;\n") - for c in poset do + var classes = poset.to_a + var todo = new Array[MClass] + var done = new HashSet[MClass] + mainmodule.linearize_mclasses(classes) + if not classes.is_empty then todo.add classes.first + while not todo.is_empty do + var c = todo.shift + if done.has(c) then continue + done.add c if c == mclass then op.append("\"{c.name}\"[shape=box,margin=0.03];\n") else op.append("\"{c.name}\"[URL=\"{c.nitdoc_url}\"];\n") end - for c2 in poset[c].direct_greaters do - op.append("\"{c.name}\"->\"{c2.name}\";\n") + var smallers = poset[c].direct_smallers + if smallers.length < 10 then + for c2 in smallers do + op.append("\"{c2.name}\"->\"{c.name}\";\n") + end + todo.add_all smallers + else + op.append("\"...\"->\"{c.name}\";\n") end end op.append("\}\n") @@ -1378,13 +1472,12 @@ class NitdocProperty end private fun tpl_intro: TplSection do - var section = new TplSection.with_title("top", tpl_title) - section.subtitle = mproperty.tpl_declaration - var article = new TplArticle("comment") - if mproperty.intro.mdoc != null then - article.content = mproperty.intro.mdoc.tpl_comment - end - section.add_child article + var title = new Template + title.add mproperty.nitdoc_name + title.add mproperty.intro.tpl_signature + var section = new TplSection.with_title("top", title) + section.subtitle = mproperty.tpl_namespace + section.summary_title = mproperty.nitdoc_name return section end