private var opt_sharedir = new OptionString("Directory containing the nitdoc files", "--sharedir")
private var opt_nodot = new OptionBool("Do not generate graphes with graphiviz", "--no-dot")
+ private var opt_custom_title: OptionString = new OptionString("Title displayed in the top of the Overview page and as suffix of all page names", "--custom-title")
+ private var opt_custom_menu_items: OptionString = new OptionString("Items displayed in menu before the 'Overview' item (Each item must be enclosed in 'li' tags)", "--custom-menu-items")
+ private var opt_custom_overview_text: OptionString = new OptionString("Text displayed as introduction of Overview page before the modules list", "--custom-overview-text")
+ private var opt_custom_footer_text: OptionString = new OptionString("Text displayed as footer of all pages", "--custom-footer-text")
+
init(toolcontext: ToolContext) do
# We need a model to collect stufs
self.toolcontext = toolcontext
toolcontext.option_context.add_option(opt_source)
toolcontext.option_context.add_option(opt_sharedir)
toolcontext.option_context.add_option(opt_nodot)
+ toolcontext.option_context.add_option(opt_custom_title)
+ toolcontext.option_context.add_option(opt_custom_footer_text)
+ toolcontext.option_context.add_option(opt_custom_overview_text)
+ toolcontext.option_context.add_option(opt_custom_menu_items)
toolcontext.process_options
process_options
model = new Model
modelbuilder = new ModelBuilder(model, toolcontext)
-
- # Here we load an process std modules
- var mmodules = modelbuilder.parse_and_build([arguments.first])
- if mmodules.is_empty then return
+ # Here we load an process all modules passed on the command line
+ var mmodules = modelbuilder.parse_and_build(arguments)
modelbuilder.full_propdef_semantic_analysis
- assert mmodules.length == 1
- self.mainmodule = mmodules.first
+ if mmodules.is_empty then return
+
+ if mmodules.length == 1 then
+ mainmodule = mmodules.first
+ else
+ # We need a main module, so we build it by importing all modules
+ mainmodule = new MModule(model, null, "<main>", new Location(null, 0, 0, 0, 0))
+ mainmodule.set_imported_mmodules(mmodules)
+ end
self.class_hierarchy = mainmodule.flatten_mclass_hierarchy
end
abort
end
end
- if not opt_source.value is null then
- source = ""
- else
- source = opt_source.value
- end
+ source = opt_source.value
end
fun start do
- if arguments.length == 1 then
- # Create destination dir if it's necessary
- if not output_dir.file_exists then output_dir.mkdir
- sys.system("cp -r {share_dir.to_s}/* {output_dir.to_s}/")
- self.dot_dir = null
- if not opt_nodot.value then self.dot_dir = output_dir.to_s
- overview
- fullindex
- modules
- classes
- quicksearch_list
- end
+ # Create destination dir if it's necessary
+ if not output_dir.file_exists then output_dir.mkdir
+ sys.system("cp -r {share_dir.to_s}/* {output_dir.to_s}/")
+ self.dot_dir = null
+ if not opt_nodot.value then self.dot_dir = output_dir.to_s
+ overview
+ fullindex
+ modules
+ classes
+ quicksearch_list
end
fun overview do
- var overviewpage = new NitdocOverview(modelbuilder, dot_dir)
+ var overviewpage = new NitdocOverview(self, dot_dir)
overviewpage.save("{output_dir.to_s}/index.html")
end
fun modules do
for mmodule in model.mmodules do
- var modulepage = new NitdocModule(mmodule, modelbuilder, dot_dir)
+ if mmodule.name == "<main>" then continue
+ var modulepage = new NitdocModule(mmodule, self, dot_dir)
modulepage.save("{output_dir.to_s}/{mmodule.url}")
end
end
content.append("\{txt: \"{mclass.name}\", url:\"{mclass.url}\" \},")
content.append("],")
end
+ var name2mprops = new HashMap[String, Set[MPropDef]]
for mproperty in model.mproperties do
if mproperty.visibility <= none_visibility then continue
if mproperty isa MAttribute then continue
- content.append("\"{mproperty.name}\": [")
- for mpropdef in mproperty.mpropdefs do
+ if not name2mprops.has_key(mproperty.name) then name2mprops[mproperty.name] = new HashSet[MPropDef]
+ name2mprops[mproperty.name].add_all(mproperty.mpropdefs)
+ end
+ for mproperty, mpropdefs in name2mprops do
+ content.append("\"{mproperty}\": [")
+ for mpropdef in mpropdefs do
content.append("\{txt: \"{mpropdef.full_name}\", url:\"{mpropdef.url}\" \},")
end
content.append("],")
var dot_dir: nullable String
var source: nullable String
+ var nitdoc: Nitdoc
- init do end
+ init(nitdoc: Nitdoc) do
+ self.nitdoc = nitdoc
+ end
fun append(str: String) do html.append(str)
var html = new Buffer
append("<script type='text/javascript' src='quicksearch-list.js'></script>")
append("<script type='text/javascript' src='scripts/js-facilities.js'></script>")
append("<link rel='stylesheet' href='styles/main.css' type='text/css' media='screen'/>")
+ var title = ""
+ if nitdoc.opt_custom_title.value != null then
+ title = " | {nitdoc.opt_custom_title.value.to_s}"
+ end
+ append("<title>{self.title}{title}</title>")
end
- fun menu is abstract
+ fun menu do
+ if nitdoc.opt_custom_menu_items.value != null then
+ append(nitdoc.opt_custom_menu_items.value.to_s)
+ end
+ end
+
+ fun title: String is abstract
fun header do
append("<header>")
fun content is abstract
fun footer do
- append("<footer>Nit standard library. Version jenkins-component=stdlib-19.</footer>")
+ if nitdoc.opt_custom_footer_text.value != null then
+ append("<footer>{nitdoc.opt_custom_footer_text.value.to_s}</footer>")
+ end
end
# Generate a clickable graphviz image using a dot content
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>)"
+ return " (<a href=\"{source.to_s}\">source</a>)"
end
end
private var mbuilder: ModelBuilder
private var mmodules = new Array[MModule]
- init(mbuilder: ModelBuilder, dot_dir: nullable String) do
- self.mbuilder = mbuilder
+ init(nitdoc: Nitdoc, dot_dir: nullable String) do
+ super(nitdoc)
+ self.mbuilder = nitdoc.modelbuilder
self.dot_dir = dot_dir
# get modules
var mmodules = new HashSet[MModule]
for mmodule in mbuilder.model.mmodules do
+ if mmodule.name == "<main>" then continue
var owner = mmodule.public_owner
if owner != null then
mmodules.add(owner)
sorter.sort(self.mmodules)
end
- redef fun head do
- super
- append("<title>Overview | Nit Standard Library</title>")
- end
+ redef fun title do return "Overview"
redef fun menu do
+ super
append("<li class='current'>Overview</li>")
append("<li><a href='full-index.html'>Full Index</a></li>")
end
redef fun content do
append("<div class='content fullpage'>")
- append("<h1>Nit Standard Library</h1>")
- append("<article class='overview'><p>Documentation for the standard library of Nit<br />Version jenkins-component=stdlib-19<br />Date: TODAY</p></article>")
+ var title = "Overview"
+ if nitdoc.opt_custom_title.value != null then
+ title = nitdoc.opt_custom_title.value.to_s
+ end
+ append("<h1>{title}</h1>")
+ var text = ""
+ if nitdoc.opt_custom_overview_text.value != null then
+ text = nitdoc.opt_custom_overview_text.value.to_s
+ end
+ append("<article class='overview'>{text}</article>")
append("<article class='overview'>")
# module list
append("<h2>Modules</h2>")
append("<ul>")
for mmodule in mmodules do
- var amodule = mbuilder.mmodule2nmodule[mmodule]
- append("<li>{mmodule.link(mbuilder)} {amodule.short_comment}</li>")
+ if mbuilder.mmodule2nmodule.has_key(mmodule) then
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
+ append("<li>{mmodule.link(mbuilder)} {amodule.short_comment}</li>")
+ end
end
append("</ul>")
# module graph
class NitdocFullindex
super NitdocPage
- private var nitdoc: Nitdoc
-
init(nitdoc: Nitdoc) do
- self.nitdoc = nitdoc
+ super(nitdoc)
self.dot_dir = null
end
- redef fun head do
- super
- append("<title>Full Index | Nit Standard Library</title>")
- end
+ redef fun title do return "Full Index"
redef fun menu do
+ super
append("<li><a href='index.html'>Overview</a></li>")
append("<li class='current'>Full Index</li>")
end
private var mmodule: MModule
private var mbuilder: ModelBuilder
- init(mmodule: MModule, mbuilder: ModelBuilder, dot_dir: nullable String) do
+ init(mmodule: MModule, nitdoc: Nitdoc, dot_dir: nullable String) do
+ super(nitdoc)
self.mmodule = mmodule
- self.mbuilder = mbuilder
+ self.mbuilder = nitdoc.modelbuilder
self.dot_dir = dot_dir
end
- redef fun head do
- super
- var amodule = mbuilder.mmodule2nmodule[mmodule]
- append("<title>{mmodule.name} module | {amodule.short_comment}</title>")
+ redef fun title do
+ if mbuilder.mmodule2nmodule.has_key(mmodule) then
+ var nmodule = mbuilder.mmodule2nmodule[mmodule]
+ return "{mmodule.name} module | {nmodule.short_comment}"
+ else
+ return "{mmodule.name} module"
+ end
end
redef fun menu do
+ super
append("<li><a href='index.html'>Overview</a></li>")
append("<li class='current'>{mmodule.name}</li>")
append("<li><a href='full-index.html'>Full Index</a></li>")
var op = new Buffer
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 m in mmodule.in_importation.poset do
+ if m.name == "<main>" then continue
var public_owner = m.public_owner
if public_owner == null then
public_owner = m
end
end
for imported in m.in_importation.direct_greaters do
+ if imported.name == "<main>" then continue
if imported.public_owner == null then
op.append("\"{public_owner.name}\"->\"{imported.name}\";\n")
end
end
fun sidebar do
- var amodule = mbuilder.mmodule2nmodule[mmodule]
append("<div class='menu'>")
append("<nav>")
append("<h3>Module Hierarchy</h3>")
# display the class column
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]
# display the property column
fun properties do
# get properties
- 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)
private var mclass: MClass
private var mbuilder: ModelBuilder
- private var nitdoc: Nitdoc
private var vtypes = new HashSet[MVirtualTypeDef]
private var consts = new HashSet[MMethodDef]
private var meths = new HashSet[MMethodDef]
private var inherited = new HashSet[MPropDef]
init(mclass: MClass, nitdoc: Nitdoc, dot_dir: nullable String, source: nullable String) do
+ super(nitdoc)
self.mclass = mclass
self.mbuilder = nitdoc.modelbuilder
- self.nitdoc = nitdoc
self.dot_dir = dot_dir
self.source = source
# load properties
end
end
- redef fun head do
- super
+ redef fun title do
var nclass = mbuilder.mclassdef2nclassdef[mclass.intro]
if nclass isa AStdClassdef then
- append("<title>{mclass.name} class | {nclass.short_comment}</title>")
+ return "{mclass.name} class | {nclass.short_comment}"
else
- append("<title>{mclass.name} class</title>")
+ return "{mclass.name} class"
end
end
redef fun menu do
+ super
append("<li><a href='index.html'>Overview</a></li>")
var public_owner = mclass.public_owner
if public_owner is null then
append("<h4>Methods</h4>")
append("<ul>")
for mprop in mts do
- if mprop.mproperty.intro_mclassdef.mclass.name == "Object" then continue
+ if mclass.name != "Object" and mprop.mproperty.intro_mclassdef.mclass.name == "Object" and mprop.mproperty.visibility <= protected_visibility then continue
append(mprop.html_sidebar_item(self))
end
append("</ul>")
# formal types
if mclass.arity > 0 and nclass isa AStdClassdef then
for ft, bound in mclass.parameter_types do
- append("<article id='{ft}'>")
+ append("<article id='FT_{ft}'>")
append("<h3 class='signature'>{ft}: {bound.link(mbuilder)}</h3>")
append("<div class=\"info\">formal generic type</div>")
append("</article>")
var nowner = mbuilder.mmodule2nmodule[owner]
append("<h3 class=\"concern-toplevel\">Methods refined in {owner.link(mbuilder)}</h3>")
if nowner.short_comment.is_empty then
- append("<p class=\"concern-doc\">{owner.name}</p>")
+ append("<p class=\"concern-doc\">{owner.link(mbuilder)}</p>")
else
- append("<p class=\"concern-doc\">{owner.name}: {nowner.short_comment}</p>")
+ append("<p class=\"concern-doc\">{owner.link(mbuilder)}: {nowner.short_comment}</p>")
end
end
if concern2meths.has_key(owner) then
var nmodule = mbuilder.mmodule2nmodule[mmodule]
if mmodule != mclass.intro_mmodule and mmodule != mclass.public_owner then
if nmodule.short_comment.is_empty then
- append("<p class=\"concern-doc\">{mmodule.name}</p>")
+ append("<p class=\"concern-doc\">{mmodule.link(mbuilder)}</p>")
else
- append("<p class=\"concern-doc\">{mmodule.name}: {nmodule.short_comment}</p>")
+ append("<p class=\"concern-doc\">{mmodule.link(mbuilder)}: {nmodule.short_comment}</p>")
end
end
var mmethods = concern2meths[mmodule]
# Return a link (html a tag) to the nitdoc module page
fun link(mbuilder: ModelBuilder): String do
- return "<a href='{url}' title='{mbuilder.mmodule2nmodule[self].short_comment}'>{name}</a>"
+ if mbuilder.mmodule2nmodule.has_key(self) then
+ return "<a href='{url}' title='{mbuilder.mmodule2nmodule[self].short_comment}'>{name}</a>"
+ else
+ return "<a href='{url}'>{name}</a>"
+ end
end
# Return the module signature decorated with html
# Return the full comment of the module decorated with html
fun html_full_comment(mbuilder: ModelBuilder): String do
var res = new Buffer
- res.append("<div id='description'>")
- res.append("<pre class='text_label'>{mbuilder.mmodule2nmodule[self].comment}</pre>")
- res.append("<textarea class='edit' rows='1' cols='76' id='fileContent'></textarea>")
- res.append("<a id='cancelBtn'>Cancel</a>")
- res.append("<a id='commitBtn'>Commit</a>")
- res.append("<pre class='text_label' id='preSave' type='2'></pre>")
- res.append("</div>")
+ if mbuilder.mmodule2nmodule.has_key(self) then
+ res.append("<div id='description'>")
+ res.append("<pre class='text_label'>{mbuilder.mmodule2nmodule[self].comment}</pre>")
+ res.append("<textarea class='edit' rows='1' cols='76' id='fileContent'></textarea>")
+ res.append("<a id='cancelBtn'>Cancel</a>")
+ res.append("<a id='commitBtn'>Commit</a>")
+ res.append("<pre class='text_label' id='preSave' type='2'></pre>")
+ res.append("</div>")
+ end
return res.to_s
end
end
return "{intro_mclassdef.mclass.html_namespace(mbuilder)}::<span>{intro.link(mbuilder)}</span>"
end
- # Return the property signature decorated with html
- fun html_signature(mbuilder: ModelBuilder): String do
- var nprop = mbuilder.mpropdef2npropdef[intro]
- return "{name}{nprop.html_signature(mbuilder)}"
- end
-
# Escape name for html output
redef fun name do return super.html_escape
end
redef fun link(mbuilder) do return "nullable {mtype.link(mbuilder)}"
end
+redef class MGenericType
+ redef fun link(mbuilder) do
+ var res = new Buffer
+ res.append("<a href='{mclass.url}'>{mclass.name}</a>[")
+ for i in [0..arguments.length[ do
+ res.append(arguments[i].link(mbuilder))
+ if i < arguments.length - 1 then res.append(", ")
+ end
+ res.append("]")
+ return res.to_s
+ end
+end
+
+redef class MParameterType
+ redef fun link(mbuilder) do
+ var name = mclass.intro.parameter_names[rank]
+ return "<a href='{mclass.url}#FT_{name}' title='formal type'>{name}</a>"
+ end
+end
+
+redef class MVirtualType
+ redef fun link(mbuilder) do return mproperty.intro.link(mbuilder)
+end
+
redef class MClassDef
# Return the classdef namespace decorated with html
fun html_namespace(mbuilder: ModelBuilder): String do
fun full_name: String do
return "{mclassdef.mclass.public_owner.name}::{mclassdef.mclass.name}::{mproperty.name}"
end
-end
-redef class MMethodDef
- redef fun html_full_desc(page) do
- if not page.mbuilder.mpropdef2npropdef.has_key(self) then
- return ""
- end
+ fun html_inheritance(page: NitdocClass): String do
var res = new Buffer
- var mprop = mproperty
- var nprop = page.mbuilder.mpropdef2npropdef[self]
- var classes = new Array[String]
- var is_redef = mprop.intro_mclassdef.mclass != page.mclass
- classes.add("fun")
- if mprop.is_init then classes.add("init")
- if is_redef then classes.add("redef")
- if mprop.visibility == none_visibility then
- classes.add("private")
- else if mprop.visibility == protected_visibility then
- classes.add("protected")
- else
- classes.add("public")
- end
- res.append("<article class='{classes.join(" ")}' id='{anchor}'>")
- res.append("<h3 class='signature'>{mprop.html_signature(page.mbuilder)}</h3>")
- res.append(html_info(page))
- res.append("<div class='description'>")
- if nprop.comment == "" then
- res.append("<a class=\"newComment\" title=\"32\" tag=\"\">New Comment</a>")
- else
- res.append("<pre class=\"text_label\" title=\"\" name=\"\" tag=\"\" type=\"1\">{nprop.comment}</pre>")
- end
- res.append("<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>")
# definitions block
- res.append("<p>")
- page.nitdoc.mainmodule.linearize_mpropdefs(mprop.mpropdefs)
- var previous_defs = new Array[MMethodDef]
- var next_defs = new Array[MMethodDef]
+ res.append("<p class='info'>")
+ page.nitdoc.mainmodule.linearize_mpropdefs(mproperty.mpropdefs)
+ var previous_defs = new Array[MPropDef]
+ var next_defs = new Array[MPropDef]
var self_passed = false
- for def in mprop.mpropdefs do
+ for def in mproperty.mpropdefs do
if def == self then
self_passed = true
continue
next_defs.add(def)
end
end
- res.append("defined by {mclassdef.mmodule.html_full_namespace(page.mbuilder)}")
+ var source = ""
+ if page.mbuilder.mpropdef2npropdef.has_key(self) then
+ source = " {page.show_source(page.mbuilder.mpropdef2npropdef[self].location)}"
+ end
+ res.append("defined by {mclassdef.mmodule.html_full_namespace(page.mbuilder)}{source}")
if not is_intro then
- res.append(", introduced by {mprop.intro.mclassdef.mclass.link(page.mbuilder)}")
+ source = ""
+ if page.mbuilder.mpropdef2npropdef.has_key(mproperty.intro) then
+ source = " {page.show_source(page.mbuilder.mpropdef2npropdef[mproperty.intro].location)}"
+ end
+ res.append(", introduced by {mproperty.intro.mclassdef.mclass.link(page.mbuilder)}{source}")
end
if not previous_defs.is_empty then
res.append(", inherited from ")
for i in [0..previous_defs.length[ do
- res.append(previous_defs[i].mclassdef.mclass.link(page.mbuilder))
- if i < previous_defs.length - 1 then res.append(", ")
+ var def = previous_defs[i]
+ source = ""
+ if page.mbuilder.mpropdef2npropdef.has_key(def) then
+ source = " {page.show_source(page.mbuilder.mpropdef2npropdef[def].location)}"
+ end
+ res.append("{def.mclassdef.mclass.link(page.mbuilder)}{source}")
+ if i < previous_defs.length - 1 then res.append(", ")
end
end
if not next_defs.is_empty then
res.append(", redefined by ")
for i in [0..next_defs.length[ do
- res.append(next_defs[i].mclassdef.mclass.link(page.mbuilder))
+ var def = next_defs[i]
+ source = ""
+ if page.mbuilder.mpropdef2npropdef.has_key(def) then
+ source = " {page.show_source(page.mbuilder.mpropdef2npropdef[def].location)}"
+ end
+ res.append("{def.mclassdef.mclass.link(page.mbuilder)}{source}")
if i < next_defs.length - 1 then res.append(", ")
end
end
res.append(".</p>")
+ return res.to_s
+ end
+end
+
+redef class MMethodDef
+ redef fun html_full_desc(page) do
+ if not page.mbuilder.mpropdef2npropdef.has_key(self) then
+ return ""
+ end
+ var res = new Buffer
+ var mprop = mproperty
+ var nprop = page.mbuilder.mpropdef2npropdef[self]
+ var classes = new Array[String]
+ var is_redef = mprop.intro_mclassdef.mclass != page.mclass
+ classes.add("fun")
+ if mprop.is_init then classes.add("init")
+ if is_redef then classes.add("redef")
+ if mprop.visibility == none_visibility then
+ classes.add("private")
+ else if mprop.visibility == protected_visibility then
+ classes.add("protected")
+ else
+ classes.add("public")
+ end
+ res.append("<article class='{classes.join(" ")}' id='{anchor}'>")
+ if nprop isa AAttrPropdef then
+ if nprop.mreadpropdef == self then
+ res.append("<h3 class='signature'>{mprop.name}: {nprop.html_signature(page.mbuilder)}</h3>")
+ else
+ res.append("<h3 class='signature'>{mprop.name}(value: {nprop.html_signature(page.mbuilder)})</h3>")
+ end
+ else
+ var intro_nprop = page.mbuilder.mpropdef2npropdef[mprop.intro]
+ res.append("<h3 class='signature'>{mprop.name}{intro_nprop.html_signature(page.mbuilder)}</h3>")
+ end
+ res.append(html_info(page))
+ res.append("<div class='description'>")
+ if nprop.comment == "" then
+ res.append("<a class=\"newComment\" title=\"32\" tag=\"\">New Comment</a>")
+ else
+ res.append("<pre class=\"text_label\" title=\"\" name=\"\" tag=\"\" type=\"1\">{nprop.comment}</pre>")
+ end
+ res.append("<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>")
+ res.append(html_inheritance(page))
res.append("</div>")
res.append("</article>")
return res.to_s
res.append("<a class=\"newComment\" title=\"32\" tag=\"\">New Comment</a>")
end
res.append("<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>")
- # definitions block
- res.append("<p>")
- page.nitdoc.mainmodule.linearize_mpropdefs(mprop.mpropdefs)
- var previous_defs = new Array[MVirtualTypeDef]
- var next_defs = new Array[MVirtualTypeDef]
- var self_passed = false
- for def in mprop.mpropdefs do
- if def == self then
- self_passed = true
- continue
- end
- if not self_passed then
- if not page.mclass.ancestors.has(def.mclassdef.mclass) then continue
- if def.is_intro then continue
- previous_defs.add(def)
- else
- if not page.mclass.descendants.has(def.mclassdef.mclass) then continue
- next_defs.add(def)
- end
- end
- res.append("defined by {mclassdef.mmodule.html_full_namespace(page.mbuilder)}")
- if not is_intro then
- res.append(", introduced by {mprop.intro.mclassdef.mclass.link(page.mbuilder)}")
- end
- if not previous_defs.is_empty then
- res.append(", inherited from ")
- for i in [0..previous_defs.length[ do
- res.append(previous_defs[i].mclassdef.mclass.link(page.mbuilder))
- if i < previous_defs.length - 1 then res.append(", ")
- end
- end
- if not next_defs.is_empty then
- res.append(", redefined by ")
- for i in [0..next_defs.length[ do
- res.append(next_defs[i].mclassdef.mclass.link(page.mbuilder))
- if i < next_defs.length - 1 then res.append(", ")
- end
- end
- res.append(".</p>")
+ res.append(html_inheritance(page))
res.append("</div>")
res.append("</article>")
return res.to_s
redef class AModule
private fun comment: String do
var ret = new Buffer
- if n_moduledecl is null or n_moduledecl.n_doc is null then ret
- if n_moduledecl.n_doc is null then return ""
+ if n_moduledecl == null or n_moduledecl.n_doc == null then return ""
for t in n_moduledecl.n_doc.n_comment do
ret.append(t.text.substring_from(1))
end
end
redef fun html_signature(mbuilder) do
- var res = ""
- if n_type != null and n_type.to_html != "" then res += ": {n_type.to_html}"
- return res
+ if n_type != null then return n_type.mtype.link(mbuilder)
+ return ""
end
end
end
redef fun html_signature(mbuilder) do
- if n_signature != null then return n_signature.to_html
+ if n_signature != null then return n_signature.to_html(mbuilder)
return ""
end
end
end
redef class ASignature
- fun to_html: String do
+ fun to_html(mbuilder: ModelBuilder): String do
#TODO closures
- var ret = ""
+ var res = new Buffer
if not n_params.is_empty then
- ret = "{ret}({n_params.join(", ")})"
+ res.append("(")
+ for i in [0..n_params.length[ do
+ res.append(n_params[i].to_html(mbuilder))
+ if i < n_params.length - 1 then res.append(", ")
+ end
+ res.append(")")
end
- if n_type != null and n_type.to_html != "" then ret += ": {n_type.to_html}"
- return ret
+ if n_type != null and n_type.mtype.link(mbuilder) != "" then res.append(": {n_type.mtype.link(mbuilder)}")
+ return res.to_s
end
end
redef class AParam
- redef fun to_s do
+ fun to_html(mbuilder: ModelBuilder): String do
var ret = "{n_id.text}"
if n_type != null then
- ret = "{ret}: {n_type.to_html}"
+ ret = "{ret}: {n_type.mtype.link(mbuilder)}"
if n_dotdotdot != null then ret = "{ret}..."
end
return ret
end
end
-redef class AType
- fun to_html: String do
- var ret = "<a href=\"{n_id.text}.html\">{n_id.text}</a>"
- if n_kwnullable != null then ret = "nullable {ret}"
- if not n_types.is_empty then ret = "{ret}[{n_types.join(", ")}]"
- return ret
- end
-
- fun name: String do return n_id.text.html_escape
-end
-
# Create a tool context to handle options and paths
var toolcontext = new ToolContext
nitlanguage / nit.git / blobdiff