private var arguments: Array[String]
private var destinationdir: nullable String
private var sharedir: nullable String
+ private var source: nullable String
private var opt_dir = new OptionString("Directory where doc is generated", "-d", "--dir")
private var opt_source = new OptionString("What link for source (%f for filename, %l for first line, %L for last line)", "--source")
# We need a model to collect stufs
self.toolcontext = toolcontext
self.arguments = toolcontext.option_context.rest
+ toolcontext.option_context.options.clear
toolcontext.option_context.add_option(opt_dir)
toolcontext.option_context.add_option(opt_source)
toolcontext.option_context.add_option(opt_sharedir)
toolcontext.option_context.add_option(opt_nodot)
+ toolcontext.process_options
process_options
if arguments.length < 1 then
abort
end
end
+ if not opt_source.value is null then
+ source = ""
+ else
+ source = opt_source.value
+ end
end
fun start do
fullindex
modules
classes
+ quicksearch_list
end
end
fun overview do
- var overviewpage = new NitdocOverview.with(modelbuilder.nmodules, self.opt_nodot.value, destinationdir.to_s)
+ var overviewpage = new NitdocOverview.with(modelbuilder, self.opt_nodot.value, destinationdir.to_s)
overviewpage.save("{destinationdir.to_s}/index.html")
end
end
fun modules do
- for mod in modelbuilder.nmodules do
- var modulepage = new NitdocModules.with(mod)
- modulepage.save("{destinationdir.to_s}/{mod.mmodule.name}.html")
+ for mmodule in model.mmodules do
+ var modulepage = new NitdocModules.with(mmodule, modelbuilder)
+ modulepage.save("{destinationdir.to_s}/{mmodule.name}.html")
end
end
fun classes do
- for amodule in modelbuilder.nmodules do
- for mclass, aclassdef in amodule.mclass2nclassdef do
- mclass.amodule(modelbuilder.mmodule2nmodule)
- mclass.mmethod(aclassdef.mprop2npropdef)
- var classpage = new NitdocMClasses.with(mclass, aclassdef)
- classpage.save("{destinationdir.to_s}/{mclass.name}.html")
+ for mclass in modelbuilder.model.mclasses do
+ var classpage = new NitdocMClasses.with(mclass, modelbuilder, source)
+ classpage.save("{destinationdir.to_s}/{mclass.name}.html")
+ end
+ end
+
+ # Generate QuickSearch file
+ fun quicksearch_list do
+ var file = new OFStream.open("{destinationdir.to_s}/quicksearch-list.js")
+ var content = new Buffer
+ content.append("var entries = \{ ")
+ for prop in model.mproperties do
+ if not prop isa MMethod then continue
+ content.append("\"{prop.name}\": [")
+ for propdef in prop.mpropdefs do
+ content.append("\{txt: \"{propdef.mproperty.full_name}\", url:\"{propdef.mproperty.link_anchor}\" \}")
+ if not propdef is prop.mpropdefs.last then content.append(", ")
end
+ content.append("]")
+ content.append(", ")
end
+
+ for mclass in model.mclasses do
+ content.append("\"{mclass.name}\": [")
+ for mclassdef in mclass.mclassdefs do
+ content.append("\{txt: \"{mclassdef.mclass.full_name}\", url:\"{mclass.link_anchor}\" \}")
+ if not mclassdef is mclass.mclassdefs.last then content.append(", ")
+ end
+ content.append("]")
+ if not mclass is model.mclasses.last then content.append(", ")
+ end
+
+ content.append(" \};")
+ file.write(content.to_s)
+ file.close
end
end
class NitdocOverview
super NitdocPage
- var amodules: Array[AModule]
+ var mbuilder: ModelBuilder
# Init with Array[AModule] to get all ifnormations about each MModule containt in a program
# opt_nodot to inform about the graph gen
# destination: to know where will be saved dot files
- init with(modules: Array[AModule], opt_nodot: Bool, destination: String) do
- self.amodules = modules
+ init with(mbuilder: ModelBuilder, opt_nodot: Bool, destination: String) do
+ self.mbuilder = mbuilder
self.opt_nodot = opt_nodot
self.destinationdir = destination
end
end
fun add_modules do
- var ls = new List[nullable MModule]
- for amodule in amodules do
- var mmodule = amodule.mmodule.public_owner
- if mmodule != null and not ls.has(mmodule) then
- open("li")
- add("a").attr("href", "{mmodule.name}.html").text("{mmodule.to_s} ")
- add_html(amodule.comment)
- close("li")
- ls.add(mmodule)
- end
+ var mmodules = list_mmodules
+ var sorted = new Array[MModule].from(mmodules)
+ var sorter = new ComparableSorter[MModule]
+ sorter.sort(sorted)
+ for mmodule in sorted do
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
+ open("li")
+ add("a").attr("href", "{mmodule.name}.html").text("{mmodule.to_s} ")
+ add_html(amodule.short_comment)
+ close("li")
end
end
fun process_generate_dot do
var op = new Buffer
op.append("digraph dep \{ 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 amodule in amodules do
- op.append("\"{amodule.mmodule.name}\"[URL=\"{amodule.mmodule.name}.html\"];\n")
- for mmodule2 in amodule.mmodule.in_importation.direct_greaters do
- op.append("\"{amodule.mmodule.name}\"->\"{mmodule2.name}\";\n")
+ for mmodule in list_mmodules do
+ op.append("\"{mmodule.name}\"[URL=\"{mmodule.name}.html\"];\n")
+ for imported in mmodule.in_importation.direct_greaters do
+ if imported.direct_owner == null then
+ op.append("\"{mmodule.name}\"->\"{imported.name}\";\n")
+ end
end
end
op.append("\}\n")
generate_dot(op.to_s, "dep", "Modules hierarchy")
end
+ private fun list_mmodules: Set[MModule] do
+ var mmodules = new HashSet[MModule]
+ for mmodule in mbuilder.model.mmodules do
+ var owner = mmodule.public_owner
+ if owner != null then
+ mmodules.add(owner)
+ else
+ mmodules.add(mmodule)
+ end
+ end
+ return mmodules
+ end
+
end
class NitdocFullindex
# Add to content modules column
fun module_column do
var ls = new List[nullable MModule]
+ var sorted = mmodules
+ var sorterp = new ComparableSorter[MModule]
+ sorterp.sort(sorted)
open("article").add_class("modules filterable")
add("h2").text("Modules")
open("ul")
- for mmodule in mmodules do
+ for mmodule in sorted do
if mmodule.public_owner != null and not ls.has(mmodule.public_owner) then
ls.add(mmodule.public_owner)
open("li")
# Add to content classes modules
fun classes_column do
+ var sorted = mmodules.first.imported_mclasses.to_a
+ var sorterp = new ComparableSorter[MClass]
+ sorterp.sort(sorted)
open("article").add_class("classes filterable")
add("h2").text("Classes")
open("ul")
- for mclass in mmodules.first.imported_mclasses do
+ for mclass in sorted do
open("li")
add("a").attr("href", "{mclass.name}.html").text(mclass.name)
close("li")
open("article").add_class("properties filterable")
add("h2").text("Properties")
open("ul")
+ var sorted_imported = mmodules.first.imported_methods.to_a
+ var sorted_redef = mmodules.first.redef_methods.to_a
+ var sorterp = new ComparableSorter[MProperty]
+ sorterp.sort(sorted_imported)
+ sorterp.sort(sorted_redef)
- for method in mmodules.first.imported_methods do
+ for method in sorted_imported do
if method.visibility is none_visibility or method.visibility is intrude_visibility then continue
open("li").add_class("intro")
add("span").attr("title", "introduction").text("I")
close("li")
end
- for method in mmodules.first.redef_methods do
+ for method in sorted_redef do
if method.visibility is none_visibility or method.visibility is intrude_visibility then continue
open("li").add_class("redef")
add("span").attr("title", "redefinition").text("R")
class NitdocModules
super NitdocPage
- var amodule: AModule
- var modulename: String
- init with(amodule: AModule) do
- self.amodule = amodule
- self.modulename = self.amodule.mmodule.name
+ var mmodule: MModule
+ var mbuilder: ModelBuilder
+
+ init with(mmodule: MModule, mbuilder: ModelBuilder) do
+ self.mmodule = mmodule
+ self.mbuilder = mbuilder
opt_nodot = false
destinationdir = ""
end
redef fun head do
super
- add("title").text("{modulename} module | {amodule.short_comment}")
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
+ add("title").text("{mmodule.name} module | {amodule.short_comment}")
end
redef fun header do
open("li")
add_html("<a href=\"index.html\">Overview</a>")
close("li")
- add("li").add_class("current").text(modulename)
+ add("li").add_class("current").text(mmodule.name)
open("li")
add_html("<a href=\"full-index.html\" >Full Index</a>")
close("li")
# Insert all tags in content part
fun add_content do
open("div").add_class("content")
- add("h1").text(modulename)
- add("div").add_class("subtitle").text("module {modulename}")
+ add("h1").text(mmodule.name)
+ add("div").add_class("subtitle").text("module {mmodule.name}")
module_comment
classes
properties
# Insert module comment in the content
fun module_comment do
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
var doc = amodule.comment
open("div").attr("id", "description")
add("pre").add_class("text_label").text(doc)
end
fun menu do
- var mmodule = amodule.mmodule
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
open("div").add_class("menu")
open("nav")
add("h3").text("Module Hierarchy").attr("style","cursor: pointer;")
- if mmodule.in_importation.direct_greaters.length > 0 then
+ if mmodule.in_importation.greaters.length > 0 then
add_html("<h4>All dependencies</h4><ul>")
- for m in mmodule.in_importation.direct_greaters do
- if m == mmodule or mmodule == m.public_owner then continue
+ var sorted = mmodule.in_importation.greaters.to_a
+ var sorter = new ComparableSorter[MModule]
+ sorter.sort(sorted)
+ for m in sorted do
+ if m == mmodule or m.public_owner != null then continue
open("li")
add("a").attr("href", "{m.name}.html").text(m.name)
close("li")
end
add_html("</ul>")
- end
- if mmodule.in_importation.greaters.length > 0 then
+ end
+ if mmodule.in_importation.smallers.length > 0 then
add_html("<h4>All clients</h4><ul>")
- for m in mmodule.in_importation.greaters do
- if m == mmodule then continue
+ var sorted = mmodule.in_importation.smallers.to_a
+ var sorter = new ComparableSorter[MModule]
+ sorter.sort(sorted)
+ for m in sorted do
+ if m == mmodule or m.public_owner != null then continue
open("li")
add("a").attr("href", "{m.name}.html").text(m.name)
close("li")
end
close("nav")
if mmodule.in_nesting.direct_greaters.length > 0 then
+ var sorted = mmodule.in_nesting.direct_greaters.to_a
+ var sorter = new ComparableSorter[MModule]
+ sorter.sort(sorted)
open("nav")
add("h3").text("Nested Modules").attr("style","cursor: pointer;")
open("ul")
- for m in mmodule.in_nesting.direct_greaters do
+ for m in sorted do
open("li")
add("a").attr("href", "{m.name}.html").text(m.name)
close("li")
end
close("ul")
-
+
close("nav")
end
close("div")
end
fun classes do
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
+ var intro_mclasses = mmodule.intro_mclasses
+ var redef_mclasses = mmodule.redef_mclasses
+ var all_mclasses = new HashSet[MClass]
+ for m in mmodule.in_nesting.greaters do
+ all_mclasses.add_all(m.intro_mclasses)
+ all_mclasses.add_all(m.redef_mclasses)
+ end
+ all_mclasses.add_all(intro_mclasses)
+ all_mclasses.add_all(redef_mclasses)
+
+ var sorted = new Array[MClass]
+ sorted.add_all(all_mclasses)
+ var sorter = new ComparableSorter[MClass]
+ sorter.sort(sorted)
open("div").add_class("module")
open("article").add_class("classes filterable")
add("h2").text("Classes")
open("ul")
- for c, state in amodule.mmodule.mclasses do
+ for c in sorted do
var name = c.name
- if state == c_is_intro or state == c_is_imported then
- open("li").add_class("intro")
- add("span").attr("title", "introduced in this module").text("I ")
- else
+ if redef_mclasses.has(c) and c.intro_mmodule.public_owner != mmodule then
open("li").add_class("redef")
add("span").attr("title", "refined in this module").text("R ")
+ else
+ open("li").add_class("intro")
+ add("span").attr("title", "introduced in this module").text("I ")
end
add("a").attr("href", "{name}.html").text(name)
close("li")
end
fun properties do
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
+ var mpropdefs = new HashSet[MPropDef]
+ for m in mmodule.in_nesting.greaters do
+ for c in m.mclassdefs do mpropdefs.add_all(c.mpropdefs)
+ end
+ for c in mmodule.mclassdefs do mpropdefs.add_all(c.mpropdefs)
+ var sorted = mpropdefs.to_a
+ var sorter = new ComparableSorter[MPropDef]
+ sorter.sort(sorted)
open("article").add_class("properties filterable")
add_html("<h2>Properties</h2>")
open("ul")
- for method in amodule.mmodule.imported_methods do
- if method.visibility is none_visibility or method.visibility is intrude_visibility then continue
- open("li").add_class("intro")
- add("span").attr("title", "introduction").text("I")
- add_html(" ")
- add("a").attr("href", "{method.local_class.name}.html").attr("title", "").text("{method.name} ({method.local_class.name})")
- close("li")
- end
-
- for method in amodule.mmodule.redef_methods do
- if method.visibility is none_visibility or method.visibility is intrude_visibility then continue
- open("li").add_class("redef")
- add("span").attr("title", "redefinition").text("R")
+ for p in sorted do
+ if p.mproperty.visibility <= none_visibility then continue
+ if p.is_intro then
+ open("li").add_class("intro")
+ add("span").attr("title", "introduction").text("I")
+ else
+ open("li").add_class("redef")
+ add("span").attr("title", "redefinition").text("R")
+ end
add_html(" ")
- add("a").attr("href", "{method.local_class.name}.html").attr("title", "").text("{method.name} ({method.local_class.name})")
+ add("a").attr("href", "{p.mclassdef.mclass.name}.html").attr("title", "").text("{p.mproperty.name} ({p.mclassdef.mclass.name})")
close("li")
end
-
close("ul")
close("article")
end
-
end
# Nit Standard Library
super NitdocPage
var mclass: MClass
- var aclassdef: AClassdef
- var stdclassdef: nullable AStdClassdef
- var public_owner: nullable MModule
+ var mbuilder: ModelBuilder
- init with(mclass: MClass, aclassdef: AClassdef) do
+ init with(mclass: MClass, mbuilder: ModelBuilder, source: nullable String) do
self.mclass = mclass
- self.aclassdef = aclassdef
- if aclassdef isa AStdClassdef then self.stdclassdef = aclassdef
- self.public_owner = mclass.intro_mmodule.public_owner
- opt_nodot = false
- destinationdir = ""
+ self.mbuilder = mbuilder
+ self.opt_nodot = false
+ self.destinationdir = ""
+ self.source = source
end
redef fun head do
super
- add("title").text("{self.mclass.name} class | Nit Standard Library")
+ var nclass = mbuilder.mclassdef2nclassdef[mclass.intro]
+ if nclass isa AStdClassdef then
+ add("title").text("{mclass.name} class | {nclass.short_comment}")
+ else
+ add("title").text("{mclass.name} class")
+ end
end
redef fun header do
add_html("<a href=\"index.html\">Overview</a>")
close("li")
open("li")
+ var public_owner = mclass.public_owner
if public_owner is null then
add_html("<a href=\"{mclass.intro_mmodule.name}.html\">{mclass.intro_mmodule.name}</a>")
else
end
fun properties_column do
+ var sorted = new Array[MProperty]
+ var sorterp = new ComparableSorter[MProperty]
open("nav").add_class("properties filterable")
add("h3").text("Properties")
if mclass.virtual_types.length > 0 then
add("h4").text("Virtual Types")
open("ul")
- for prop in mclass.virtual_types do
+ sorted = mclass.virtual_types.to_a
+ sorterp.sort(sorted)
+ for prop in sorted do
add_html("<li class=\"redef\"><span title=\"Redefined\">R</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
end
close("ul")
end
if mclass.constructors.length > 0 then
+ sorted = mclass.constructors.to_a
+ sorterp.sort(sorted)
add("h4").text("Constructors")
open("ul")
- for prop in mclass.constructors do
+ for prop in sorted do
add_html("<li class=\"intro\"><span title=\"Introduced\">I</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
end
close("ul")
add("h4").text("Methods")
open("ul")
if mclass.intro_methods.length > 0 then
- for prop in mclass.intro_methods do
+ sorted = mclass.intro_methods.to_a
+ sorterp.sort(sorted)
+ for prop in sorted do
if prop.visibility is public_visibility or prop.visibility is protected_visibility then add_html("<li class=\"intro\"><span title=\"Introduced\">I</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
end
end
if mclass.inherited_methods.length > 0 then
- for prop in mclass.inherited_methods do
+ sorted = mclass.inherited_methods.to_a
+ sorterp.sort(sorted)
+ for prop in sorted do
if prop.visibility is public_visibility or prop.visibility is protected_visibility then add_html("<li class=\"inherit\"><span title=\"Inherited\">H</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
end
end
if mclass.redef_methods.length > 0 then
- for prop in mclass.redef_methods do
+ sorted = mclass.redef_methods.to_a
+ sorterp.sort(sorted)
+ for prop in sorted do
if prop.visibility is public_visibility or prop.visibility is protected_visibility then add_html("<li class=\"redef\"><span title=\"Refined\">R</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
end
end
end
fun inheritance_column do
+ var sorted = new Array[MClass]
+ var sorterp = new ComparableSorter[MClass]
open("nav")
add("h3").text("Inheritance")
if mclass.parents.length > 0 then
+ sorted = mclass.parents.to_a
+ sorterp.sort(sorted)
add("h4").text("Superclasses")
open("ul")
- for sup in mclass.parents do add_html("<li><a href=\"{sup.name}.html\">{sup.name}</a></li>")
+ for sup in sorted do add_html("<li><a href=\"{sup.name}.html\">{sup.name}</a></li>")
close("ul")
end
if mclass.descendants.length is 0 then
add("h4").text("No Known Subclasses")
else if mclass.descendants.length <= 100 then
+ sorted = mclass.descendants.to_a
+ sorterp.sort(sorted)
add("h4").text("Subclasses")
open("ul")
- for sub in mclass.descendants do add_html("<li><a href=\"{sub.name}\">{sub.name}</a></li>")
+ for sub in sorted do add_html("<li><a href=\"{sub.name}\">{sub.name}</a></li>")
close("ul")
else if mclass.children.length <= 100 then
+ sorted = mclass.children.to_a
+ sorterp.sort(sorted)
add("h4").text("Direct Subclasses Only")
open("ul")
- for sub in mclass.children do add_html("<li><a href=\"{sub.name}\">{sub.name}</a></li>")
+ for sub in sorted do add_html("<li><a href=\"{sub.name}\">{sub.name}</a></li>")
close("ul")
else
add("h4").text("Too much Subclasses to list")
end
fun content do
+ var nclass = mbuilder.mclassdef2nclassdef[mclass.intro]
+ var sorted = new Array[MModule]
+ sorted.add_all(mclass.concerns.keys)
+ var sorterp = new ComparableSorter[MModule]
+ var sorterprop = new ComparableSorter[MProperty]
+ var sorterc = new ComparableSorter[MClass]
+ sorterp.sort(sorted)
var subtitle = ""
var lmmodule = new List[MModule]
# Insert the subtitle part
add_html("<div style=\"float: right;\"><a id=\"lblDiffCommit\"></a></div>")
# We add the class description
open("section").add_class("description")
- if not stdclassdef is null and not stdclassdef.comment.is_empty then add_html("<pre class=\"text_label\" title=\"122\" name=\"\" tag=\"{mclass.mclassdefs.first.location.to_s}\" type=\"2\">{stdclassdef.comment} </pre><textarea id=\"fileContent\" class=\"edit\" cols=\"76\" rows=\"1\" style=\"display: none;\"></textarea><a id=\"cancelBtn\" style=\"display: none;\">Cancel</a><a id=\"commitBtn\" style=\"display: none;\">Commit</a><pre id=\"preSave\" class=\"text_label\" type=\"2\"></pre>")
+ if nclass isa AStdClassdef and not nclass.comment.is_empty then add_html("<pre class=\"text_label\" title=\"122\" name=\"\" tag=\"{mclass.mclassdefs.first.location.to_s}\" type=\"2\">{nclass.comment} </pre><textarea id=\"fileContent\" class=\"edit\" cols=\"76\" rows=\"1\" style=\"display: none;\"></textarea><a id=\"cancelBtn\" style=\"display: none;\">Cancel</a><a id=\"commitBtn\" style=\"display: none;\">Commit</a><pre id=\"preSave\" class=\"text_label\" type=\"2\"></pre>")
close("section")
open("section").add_class("concerns")
add("h2").add_class("section-header").text("Concerns")
open("ul")
- for owner, childs in mclass.concerns do
+ for owner in sorted do
+ var nmodule = mbuilder.mmodule2nmodule[owner]
+ var childs = mclass.concerns[owner]
open("li")
- add_html("<a href=\"#MOD_{owner.name}\">{owner.name}</a>: {owner.amodule.short_comment}")
+ add_html("<a href=\"#MOD_{owner.name}\">{owner.name}</a>: {nmodule.short_comment}")
if not childs is null then
open("ul")
- for child in childs.as(not null) do add_html("<li><a href=\"#MOD_{child.name}\">{child.name}</a>: {child.amodule.short_comment} </li>")
+ var sortedc = childs.to_a
+ var sorterpc = new ComparableSorter[MModule]
+ sorterpc.sort(sortedc)
+ for child in sortedc do
+ var nchild = mbuilder.mmodule2nmodule[child]
+ add_html("<li><a href=\"#MOD_{child.name}\">{child.name}</a>: {nchild.short_comment} </li>")
+ end
close("ul")
end
close("li")
close("ul")
close("section")
# Insert virtual types if there is almost one
- if mclass.virtual_types.length > 0 or (stdclassdef != null and stdclassdef.n_formaldefs.length > 0) then
+ if mclass.virtual_types.length > 0 or mclass.arity > 0 then
open("section").add_class("types")
add("h2").text("Formal and Virtual Types")
if mclass.virtual_types.length > 0 then for prop in mclass.virtual_types do description(prop)
- if stdclassdef.n_formaldefs.length > 0 then
- for prop in stdclassdef.n_formaldefs do
+ if mclass.arity > 0 and nclass isa AStdClassdef then
+ for prop in nclass.n_formaldefs do
open("article").attr("id", "FT_Object_{prop.collect_text}")
open("h3").add_class("signature").text("{prop.collect_text}: nullable ")
add_html("<a title=\"The root of the class hierarchy.\" href=\"Object.html\">Object</a>")
end
# Insert constructors if there is almost one
if mclass.constructors.length > 0 then
+ var sortedc = mclass.constructors.to_a
+ sorterprop.sort(sortedc)
open("section").add_class("constructors")
add("h2").add_class("section-header").text("Constructors")
- for prop in mclass.constructors do description(prop)
+ for prop in sortedc do description(prop)
close("section")
end
open("section").add_class("methods")
add("h2").add_class("section-header").text("Methods")
for mmodule, mmethods in mclass.all_methods do
+ var nmodule = mbuilder.mmodule2nmodule[mmodule]
add_html("<a id=\"MOD_{mmodule.name}\"></a>")
if mmodule != mclass.intro_mmodule and mmodule != mclass.public_owner then
if mclass.has_mmodule(mmodule) then
- add_html("<p class=\"concern-doc\">{mmodule.name}: {mmodule.amodule.short_comment}</p>")
+ add_html("<p class=\"concern-doc\">{mmodule.name}: {nmodule.short_comment}</p>")
else
- add_html("<h3 class=\"concern-toplevel\">Methods refined in <a href=\"{mmodule.name}.html\">{mmodule.name}</a></h3><p class=\"concern-doc\">{mmodule.name}: {mmodule.amodule.short_comment}</p>")
+ add_html("<h3 class=\"concern-toplevel\">Methods refined in <a href=\"{mmodule.name}.html\">{mmodule.name}</a></h3><p class=\"concern-doc\">{mmodule.name}: {nmodule.short_comment}</p>")
end
end
- for prop in mmethods do description(prop)
+ var sortedc = mmethods.to_a
+ sorterprop.sort(sortedc)
+ for prop in sortedc do description(prop)
end
# Insert inherited methods
if mclass.inherited_methods.length > 0 then
+ var sortedc = new Array[MClass]
+ sortedc.add_all(mclass.inherited.keys)
+ sorterc.sort(sortedc)
add("h3").text("Inherited Methods")
- for i_mclass, methods in mclass.inherited do
+ for i_mclass in sortedc do
+ var sortedp = mclass.inherited[i_mclass].to_a
+ sorterprop.sort(sortedp)
open("p")
add_html("Defined in <a href=\"{i_mclass.name}.html\">{i_mclass.name}</a>: ")
- for method in methods do
+ for method in sortedp do
add_html("<a href=\"{method.link_anchor}\">{method.name}</a>")
- if method != methods.last then add_html(", ")
+ if method != sortedp.last then add_html(", ")
end
close("p")
end
open("p")
if prop.local_class != mclass then add_html("inherited from {prop.local_class.intro_mmodule.name} ")
#TODO display show code if doc github
- add_html("defined by the module <a href=\"{prop.intro_mclassdef.mmodule.name}.html\">{prop.intro_mclassdef.mmodule.name}</a> (<a href=\"\">show code</a>).")
+ add_html("defined by the module <a href=\"{prop.intro_mclassdef.mmodule.name}.html\">{prop.intro_mclassdef.mmodule.name}</a> {if prop.apropdef is null then "" else show_source(prop.apropdef.location)}.")
for parent in mclass.parents do
if prop isa MMethod then if parent.constructors.has(prop) then add_html(" Previously defined by: <a href=\"{parent.intro_mmodule.name}.html\">{parent.intro_mmodule.name}</a> for <a href=\"{parent.name}.html\">{parent.name}</a>.")
var opt_nodot: Bool
var destinationdir : String
+ var source: nullable String
redef fun head do
add("meta").attr("charset", "utf-8")
fmap.close
end
+ # Add a (source) link fo a given location
+ fun show_source(l: Location): String
+ do
+ if source == null then
+ return "({l.file.filename.simplify_path})"
+ else
+ # THIS IS JUST UGLY ! (but there is no replace yet)
+ var x = source.split_with("%f")
+ source = x.join(l.file.filename.simplify_path)
+ x = source.split_with("%l")
+ source = x.join(l.line_start.to_s)
+ x = source.split_with("%L")
+ source = x.join(l.line_end.to_s)
+ return " (<a href=\"{source.to_s}\">show code</a>)"
+ end
+ end
+
end
redef class AModule
if n_moduledecl is null or n_moduledecl.n_doc is null then ret
if n_moduledecl.n_doc is null then return ""
for t in n_moduledecl.n_doc.n_comment do
- ret += "{t.text.replace("# ", "")}"
+ var txt = t.text
+ txt = txt.replace("# ", "")
+ txt = txt.replace("#", "")
+ ret += txt
end
return ret
end
redef class MModule
+ super Comparable
+ redef type OTHER: MModule
+ redef fun <(other: OTHER): Bool do return self.name < other.name
+
var amodule: nullable AModule
# Get the list of all methods in a module
return methods
end
end
+redef class MPropDef
+ super Comparable
+ redef type OTHER: MPropDef
+ redef fun <(other: OTHER): Bool do return self.mproperty.name < other.mproperty.name
+end
redef class MProperty
+ super Comparable
+ redef type OTHER: MProperty
+ redef fun <(other: OTHER): Bool do return self.name < other.name
+
var is_redef: Bool
var apropdef: nullable APropdef
redef class MClass
+ super Comparable
+ redef type OTHER: MClass
+ redef fun <(other: OTHER): Bool do return self.name < other.name
+
# Associate all MMethods to each MModule concerns
fun all_methods: HashMap[MModule, Set[MMethod]] do
var hm = new HashMap[MModule, Set[MMethod]]
# Create a tool context to handle options and paths
var toolcontext = new ToolContext
-toolcontext.process_options
# Here we launch the nit index
var nitdoc = new Nitdoc(toolcontext)
nitlanguage / nit.git / blobdiff