readable var _opt_dir: OptionString = new OptionString("Directory where doc is generated", "-d", "--dir")
readable var _opt_source: OptionString = new OptionString("What link for source (%f for filename, %l for first line, %L for last line)", "--source")
readable var _opt_public: OptionBool = new OptionBool("Generate only the public API", "--public")
+ readable var _opt_private: OptionBool = new OptionBool("Generate the private API", "--private")
+ readable var _opt_nodot: OptionBool = new OptionBool("Do not generate graphes with graphviz", "--no-dot")
+ readable var _opt_sharedir: OptionString = new OptionString("Directory containing the nitdoc files", "--sharedir")
+
+ readable 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")
+ readable 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")
+ readable var _opt_custom_overview_text: OptionString = new OptionString("Text displayed as introduction of Overview page before the modules list", "--custom-overview-text")
+ readable var _opt_custom_footer_text: OptionString = new OptionString("Text displayed as footer of all pages", "--custom-footer-text")
+ var sharedir: nullable String
fun public_only: Bool
do
return false
end
+ fun with_private: Bool
+ do
+ if self._opt_private.value == true then return true
+ return false
+ end
+
# The current processed filename
var filename: String
dir.mkdir
+ sys.system("cp -r '{sharedir.to_s}'/* {dir}/")
+
# Compute the set of direct owned nested modules
var owns = new HashMap[MMModule, Array[MMModule]]
for mod in modules do
m.tmhe_ = tmh.add(m, pub)
end
- var head = "<script type=\"text/javascript\" src=\"http://moz-concept.com/nitdoc/scripts/jquery-1.7.1.min.js\"></script>\n" +
- "<script type=\"text/javascript\" src=\"http://moz-concept.com/nitdoc/scripts/js-facilities.js\"></script>\n" +
- "<link rel=\"stylesheet\" href=\"http://moz-concept.com/nitdoc/styles/main.css\" type=\"text/css\" media=\"screen\">"
+ var head = "<meta charset=\"utf-8\">" +
+ "<script type=\"text/javascript\" src=\"scripts/jquery-1.7.1.min.js\"></script>\n" +
+ "<script type=\"text/javascript\" src=\"quicksearch-list.js\"></script>\n" +
+ "<script type=\"text/javascript\" src=\"scripts/js-facilities.js\"></script>\n" +
+ "<link rel=\"stylesheet\" href=\"styles/main.css\" type=\"text/css\" media=\"screen\" />"
+
+ var custom_items = ""
+ if self._opt_custom_menu_items.value != null then custom_items = self._opt_custom_menu_items.value.as(not null)
- var action_bar = "<header><nav class='main'><ul><li><a href='.'>Overview</a></li><li><a href='full-index.html'>Full Index</a></li></ul></nav></header>\n"
+ var action_bar = "<header><nav class='main'><ul>{custom_items}<li class=\"current\">Overview</li><li><a href='full-index.html'>Full Index</a></li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
+
+ var custom_title = "Nitdoc"
+ if self._opt_custom_title.value != null then custom_title = self._opt_custom_title.value.as(not null)
+
+ var overview_text = ""
+ if self._opt_custom_overview_text.value != null then overview_text = self._opt_custom_overview_text.value.as(not null)
+ var footer_text = ""
+ if self._opt_custom_footer_text.value != null then footer_text = self._opt_custom_footer_text.value.as(not null)
+
# generate the index
self.filename = "index.html"
clear
- add("<html><head>{head}</head><body>\n")
+ add("<!DOCTYPE html>")
+ add("<html><head>{head}<title>Overview | {custom_title}</title></head><body>\n")
add(action_bar)
add("<div class=\"page\">")
add("<div class=\"content fullpage\">")
- add("<h1>Modules</h1>\n<article class='overview'><ul>")
+ add("<h1>{custom_title}</h1>\n<article class='overview'>{overview_text}</article><article class='overview'><h2>Modules</h2><ul>")
var modss = mainmod.mhe.greaters_and_self.to_a
sort(modss)
for mod in modss do
end
end
op.append("\}\n")
- self.gen_dot(op.to_s, "dep")
+ self.gen_dot(op.to_s, "dep", "Modules hierarchy")
add("</article></div>")
- add("<div class='clear'></div>")
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/index.html")
assert mod isa MMSrcModule
if not mod.require_doc(self) then continue
self.filename = mod.html_name
+ action_bar = "<header><nav class='main'><ul>{custom_items}<li><a href='./index.html'>Overview</a></li><li class=\"current\">{mod.name}</li><li><a href='full-index.html'>Full Index</a></li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
clear
- add("<html><head>{head}<title>Module {mod.name}</title></head><body>\n")
+ add("<!DOCTYPE html>")
+ add("<html><head>{head}<title>{mod.name} module | {custom_title}</title></head><body>\n")
add(action_bar)
add("<div class=\"page\">")
mod.file_page_doc(self)
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/{mod.html_name}.html")
end
for c in mainmod.local_classes do
if not c.require_doc(self) then continue
self.filename = c.html_name
+ action_bar = "<header><nav class='main'><ul>{custom_items}<li><a href='./index.html'>Overview</a></li><li>{c.global.intro.mmmodule.toplevel_owner.html_link(self)}</li><li class=\"current\">{c.name}</li><li><a href='full-index.html'>Full Index</a></li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
clear
- add("<html><head>{head}<title>Class {c.name}</title></head><body>\n")
+ add("<!DOCTYPE html>")
+ add("<html><head>{head}<title>{c.name} class | {custom_title}</title></head><body>\n")
add(action_bar)
add("<div class=\"page\">")
c.file_page_doc(self)
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/{c.html_name}.html")
end
self.filename = "fullindex"
+ action_bar = "<header><nav class='main'><ul>{custom_items}<li><a href='./index.html'>Overview</a></li><li class=\"current\">Full Index</li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
clear
- add("<html><head>{head}</head><body>\n")
+ add("<!DOCTYPE html>")
+ add("<html><head>{head}<title>Full Index | {custom_title}</title></head><body>\n")
add(action_bar)
add("<div class=\"page\">")
add("<div class=\"content fullpage\">")
mainmod.file_index_page_doc(self)
add("</div>")
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/full-index.html")
+
+ self.filename = "quicksearch-list"
+ clear
+ mainmod.file_quicksearch_list_doc(self)
+ write_to("{dir}/quicksearch-list.js")
end
do
var s = opt_source.value
if s == null then
- add("in #{l.file.filename}")
+ add("({l.file.filename.simplify_path})")
else
# THIS IS JUST UGLY ! (but there is no replace yet)
var x = s.split_with("%f")
- s = x.join(l.file.filename)
+ s = x.join(l.file.filename.simplify_path)
x = s.split_with("%l")
s = x.join(l.line_start.to_s)
x = s.split_with("%L")
# Generate a clicable graphiz image using a dot content.
# `name' refer to the filename (without extension) and the id name of the map.
# `name' must also match the name of the graph in the dot content (eg. digraph NAME {...)
- fun gen_dot(dot: String, name: String)
+ fun gen_dot(dot: String, name: String, alt: String)
do
+ if opt_nodot.value then return
var f = new OFStream.open("{self.dir}/{name}.dot")
f.write(dot)
f.close
sys.system("\{ test -f {self.dir}/{name}.png && test -f {self.dir}/{name}.s.dot && diff {self.dir}/{name}.dot {self.dir}/{name}.s.dot >/dev/null 2>&1 ; \} || \{ cp {self.dir}/{name}.dot {self.dir}/{name}.s.dot && dot -Tpng -o{self.dir}/{name}.png -Tcmapx -o{self.dir}/{name}.map {self.dir}/{name}.s.dot ; \}")
- self.add("<div><img src=\"{name}.png\" usemap=\"#{name}\" style=\"margin:auto\"/></div>")
+ self.add("<article class=\"graph\"><img src=\"{name}.png\" usemap=\"#{name}\" style=\"margin:auto\" alt=\"{alt}\"/></article>")
var fmap = new IFStream.open("{self.dir}/{name}.map")
self.add(fmap.read_all)
fmap.close
super("nitdoc")
filename = "-unset-"
option_context.add_option(opt_public)
+ option_context.add_option(opt_private)
option_context.add_option(opt_dir)
option_context.add_option(opt_source)
+ option_context.add_option(opt_nodot)
+ option_context.add_option(opt_sharedir)
+ option_context.add_option(opt_custom_title)
+ option_context.add_option(opt_custom_menu_items)
+ option_context.add_option(opt_custom_overview_text)
+ option_context.add_option(opt_custom_footer_text)
end
redef fun process_options
super
var d = opt_dir.value
if d != null then dir = d
+
+ if not opt_nodot.value then
+ # Test if dot is runable
+ var res = sys.system("sh -c dot </dev/null >/dev/null 2>&1")
+ if res != 0 then
+ stderr.write "--no-dot implied since `dot' is not available. Try to install graphviz.\n"
+ opt_nodot.value = true
+ end
+ end
+
+ sharedir = opt_sharedir.value
+ if sharedir == null then
+ var dir = "NIT_DIR".environ
+ if dir.is_empty then
+ dir = "{sys.program_name.dirname}/../share/nitdoc"
+ if dir.file_exists then sharedir = dir
+ else
+ dir = "{dir}/share/nitdoc"
+ if dir.file_exists then sharedir = dir
+ end
+ if sharedir == null then
+ fatal_error(null, "Error: Cannot locate nitdoc shared files. Uses --sharedir or envvar NIT_DIR.")
+ end
+ dir = "{sharedir.to_s}/scripts/js-facilities.js"
+ if sharedir == null then
+ fatal_error(null, "Error: Invalid nitdoc shared files. Check --sharedir or envvar NIT_DIR.")
+ end
+
+ end
end
redef fun handle_property_conflict(lc, impls)
end
# Generalization of metamodel entities
-class MMEntity
+interface MMEntity
# Return a link to
fun html_link(dctx: DocContext): String is abstract
# The doc node from the AST
# Return null is none
fun doc: nullable ADoc do return null
+
+ # Return a JSON entry for quicksearch list
+ fun json_entry(dctx: DocContext): String is abstract
+
+ # Return the qualified name as string
+ fun qualified_name: String is abstract
+
end
redef class MMModule
super MMEntity
redef fun html_link(dctx) do
- return "<a href=\"{html_name}.html\">{self}</a>"
+ if short_doc == " " then
+ return "<a href=\"{html_name}.html\"\">{self}</a>"
+ else
+ return "<a href=\"{html_name}.html\" title=\"{short_doc}\">{self}</a>"
+ end
+ end
+
+ fun html_anchor: String do
+ return "<a id=\"MOD_{html_name}\"></a>"
+ end
+
+ fun html_link_to_anchor: String do
+ return "<a href=\"#MOD_{html_name}\" title=\"Jump to definitions from module {html_name}\">{self}</a>"
+ end
+
+ redef fun json_entry(dctx) do
+ return "\{txt:\"{self.qualified_name}\",url:\"{html_name}.html\"\},"
+ end
+
+ redef fun qualified_name do
+ var buffer = new Buffer
+ for m in mnhe.smallers do
+ buffer.append("{m.html_name}::")
+ end
+ buffer.append("{self.name}")
+ return buffer.to_s
end
fun require_doc(dctx: DocContext): Bool
end
end
op.append("\}\n")
- dctx.gen_dot(op.to_s, name.to_s)
+ dctx.gen_dot(op.to_s, name.to_s, "Dependency graph for module {name}")
dctx.add("</section>")
var clas = new Array[MMLocalClass]
end
if not keep then continue
clas.add(self[g])
+ lc.compute_super_classes
for gp in lc.global_properties do
if self.visibility_for(gp.intro.local_class.mmmodule) <= 1 then continue # private import or invisible import
var lp = lc[gp]
var lpi = self[gp.intro.local_class.global][gp]
if lps.has(lpi) then
- dctx.add("<li class='intro'><span title='introduction in an other module'>I</span> <a href=\"{lpi.local_class.html_name}.html#{lpi.html_anchor}\">{lpi} ({lpi.local_class})</a></li>\n")
+ dctx.add("<li class='intro'><span title='introduction in an other module'>I</span> {lpi.html_open_link(dctx)}{lpi.html_name} ({lpi.local_class})</a></li>\n")
lps.remove(lpi)
else
- dctx.add("<li class='intro'><span title='introduction in this module'>I</span> {lpi}")
+ dctx.add("<li class='intro'><span title='introduction in this module'>I</span> {lpi.html_name}")
dctx.add(" ({lpi.local_class})</li>\n")
end
if lps.length >= 1 then
dctx.sort(lps)
for lp in lps do
- dctx.add("<li class='redef'><span title='redefinition'>R</span> <a href=\"{lp.local_class.html_name}.html#{lp.html_anchor}\">{lp} ({lp.local_class})</a></li>")
+ dctx.add("<li class='redef'><span title='redefinition'>R</span> {lp.html_open_link(dctx)}{lp.html_name} ({lp.local_class})</a></li>")
end
end
end
dctx.stage("</ul></article>\n")
dctx.close_stage
-
-
- dctx.add("</div>\n")
+ dctx.add("</section>\n")
dctx.add("</div>\n")
end
var lpi = self[gp.intro.local_class.global][gp]
lps.remove(lpi)
- dctx.add("<li class='intro'><span title='introduction'>I</span> <a href=\"{lpi.local_class.html_name}.html#{lpi.html_anchor}\">{lpi} ({lpi.local_class})</a></li>\n")
+ dctx.add("<li class='intro'><span title='introduction'>I</span> {lpi.html_open_link(dctx)}{lpi.html_name} ({lpi.local_class})</a></li>\n")
if lps.length >= 1 then
dctx.sort(lps)
for lp in lps do
- dctx.add("<li class='redef'><span title='redefinition'>R</span> <a href=\"{lp.local_class.html_name}.html#{lp.html_anchor}\">{lp} ({lp.local_class})</a></li>\n")
+ dctx.add("<li class='redef'><span title='redefinition'>R</span> {lp.html_open_link(dctx)}{lp.html_name} ({lp.local_class})</a></li>\n")
end
end
end
dctx.stage("</ul></article>\n")
dctx.close_stage
end
+
+ # Fill the quicksearch list JSON object
+ fun file_quicksearch_list_doc(dctx: DocContext)
+ do
+ var entities = new HashMap[String, Array[MMEntity]]
+ var props = new HashMap[MMGlobalProperty, Array[MMLocalProperty]]
+ for m in mhe.greaters_and_self do
+ if not m.require_doc(dctx) then continue
+ var a = new Array[MMEntity]
+ a.add(m)
+ entities[m.html_name] = a
+ end
+ for g in global_classes do
+ var lc = self[g]
+ if not lc.require_doc(dctx) then continue
+ var a = new Array[MMEntity]
+ a.add(lc)
+ entities[lc.html_name] = a
+ for gp in lc.global_properties do
+ var lp = lc[gp]
+ if not lp.require_doc(dctx) then continue
+ if lp.kind == "var" then continue
+ if props.has_key(lp.global) then
+ if not props[lp.global].has(lp) then
+ props[lp.global].add(lp)
+ end
+ else
+ props[lp.global] = [lp]
+ end
+ end
+ end
+
+ for k, v in props do
+ entities[k.short_name] = v
+ end
+
+ var keys = entities.keys.to_a
+ var sorter = new AlphaSorter[String]
+ sorter.sort(keys)
+
+ dctx.open_stage
+ dctx.stage("var entries = \{")
+ for key in keys do
+ dctx.add("\"{key}\": [")
+ for entity in entities[key] do
+ dctx.add(entity.json_entry(dctx))
+ end
+ dctx.add("],")
+ end
+ dctx.stage("\};")
+ dctx.close_stage
+ end
end
+redef class MMGlobalProperty
+ # Return the short name of the property
+ fun short_name: String do
+ return self.intro.html_name
+ end
+end
+
redef class MMLocalProperty
super MMEntity
# Anchor of the property description in the module html file
fun html_anchor: String
do
- return "PROP_{local_class}_{cmangle(name)}"
+ return "PROP_{self.mmmodule.toplevel_owner}_{local_class}_{cmangle(name)}"
+ end
+
+ redef fun json_entry(dctx) do
+ return "\{txt:\"{qualified_name}\",url:\"{local_class.html_name}.html#{html_anchor}\"\},"
+ end
+
+ redef fun qualified_name do
+ return "{intro_module.qualified_name}::{local_class.html_name}::{html_name}"
+ end
+
+ fun html_open_link(dctx: DocContext): String
+ do
+ if not require_doc(dctx) then print "not required {self}"
+ var title = "{html_name}{signature.to_s}"
+ if short_doc != " " then
+ title += " #{short_doc}"
+ end
+ return "<a href=\"{local_class.html_name}.html#{html_anchor}\" title=\"{title}\">"
+ end
+
+ fun html_name: String
+ do
+ return self.name.to_s.html_escape
end
redef fun html_link(dctx)
do
if not require_doc(dctx) then print "not required {self}"
- return "<a href=\"{local_class.html_name}.html#{html_anchor}\">{self}</a>"
+ var title = "{html_name}{signature.to_s}"
+ if short_doc != " " then
+ title += " #{short_doc}"
+ end
+ return "<a href=\"{local_class.html_name}.html#{html_anchor}\" title=\"{title}\">{html_name}</a>"
end
fun html_link_special(dctx: DocContext, lc: MMLocalClass): String
do
if not require_doc(dctx) then print "not required {self}"
- return "<a href=\"{lc.html_name}.html#{html_anchor}\">{self}</a>"
+ var title = "{html_name}{signature_for(lc.get_type)}"
+ if short_doc != " " then
+ title += " #{short_doc}"
+ end
+ return "<a href=\"{lc.html_name}.html#{html_anchor}\" title=\"{title}\">{html_name}</a>"
end
# Kind of property (fun, attr, etc.)
return m == m.toplevel_owner
end
- # Return true if the global class must be documented according to the visibility configured
+ # Return true if the global property must be documented according to the visibility configured
fun require_doc(dctx: DocContext): Bool
do
- if global.visibility_level == 3 then return false # Private
+ if global.visibility_level == 3 and not dctx.with_private then return false # Private
if dctx.public_only then
var m = intro_module
if m != m.toplevel_owner then return false # Unexported
var is_redef = local_class.global != intro_class.global or local_class.mmmodule.toplevel_owner != intro_class.mmmodule.toplevel_owner
dctx.add("<article id=\"{html_anchor}\" class=\"{kind} {visibility} {if is_redef then "redef" else ""}\">\n")
- dctx.add("<h3 class=\"signature\">{name}{signature.to_html(dctx, true)}</h3>\n")
+ dctx.add("<h3 class=\"signature\">{html_name}{signature.to_html(dctx, true)}</h3>\n")
dctx.add("<div class=\"info\">\n")
#dctx.add("<p>LP: {self.mmmodule.html_link(dctx)}::{self.local_class.html_link(dctx)}::{self.html_link(dctx)}</p>")
dctx.add("::{mmmodule[intro_class.global].html_link(dctx)}")
end
if is_redef then
- dctx.add("::{mmmodule[intro_class.global][global].html_link(dctx)}")
+ dctx.add("::{mmmodule[intro_class.global][global].global.intro.html_link(dctx)}")
else
- dctx.add("::{name}")
+ dctx.add("::{html_name}")
end
dctx.add("</div>")
if lp == tlp then continue
dctx.add(" {lp.mmmodule.html_link(dctx)}")
if lp.local_class.global != lc.global then
- dctx.add(" for {lp.local_class.html_link(dctx)}")
+ dctx.add(" for {lp.local_class.html_link(dctx)} ")
end
n = lp.node
for c in n_comment do
res.append(c.text.substring_from(1))
end
- return res.to_s
+ return res.to_s.html_escape
end
# Oneliner transcription of the doc
fun short: String
do
- return n_comment.first.text.substring_from(1)
+ return n_comment.first.text.substring_from(1).html_escape
end
end
redef fun html_link(dctx)
do
if not require_doc(dctx) then print "{dctx.filename}: not required {self}"
- return "<a href=\"{html_name}.html\">{self}</a>"
+ if short_doc == " " then
+ return "<a href=\"{html_name}.html\"\">{self}</a>"
+ else
+ return "<a href=\"{html_name}.html\" title=\"{short_doc}\">{self}</a>"
+ end
+ end
+
+ redef fun json_entry(dctx) do
+ return "\{txt:\"{qualified_name}\",url:\"{html_name}.html\"\},"
+ end
+
+ redef fun qualified_name do
+ return "{intro_module.qualified_name}::{html_name}"
end
redef fun short_doc do return global.intro.short_doc
# Return true if the global class must be documented according to the visibility configured
fun require_doc(dctx: DocContext): Bool
do
- if global.visibility_level == 3 then return false # Private
+ if global.visibility_level == 3 and not dctx.with_private then return false # Private
if dctx.public_only then
var m = intro_module
if m != m.toplevel_owner then return false # Unexported
dctx.add("<nav class=\"inheritance filterable\">\n")
dctx.add("<h3>Inheritance</h3>\n")
- dctx.add("<h4>Superclasses</h3>\n<ul>\n")
+ dctx.add("<h4>Superclasses</h4>\n<ul>\n")
for lc in cshe.linear_extension do
if lc == self then continue
if not lc.require_doc(dctx) then continue
cla.add_all(cshe.greaters_and_self)
var op = new Buffer
+ var name = "class_{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 cla do
if c == self then
end
end
op.append("\}\n")
- dctx.gen_dot(op.to_s, name.to_s)
+ dctx.gen_dot(op.to_s, name.to_s, "Inheritance graph for class {name}")
+ dctx.add("</section>\n")
+ # Concerns table
+ dctx.open_stage
+ dctx.stage("<section class=\"concerns\">\n")
+ dctx.stage("<h2 class=\"section-header\">Concerns</h2>\n")
var mods = new Array[MMModule]
mods.add(global.intro.mmmodule.toplevel_owner)
var m = lc.mmmodule.toplevel_owner
if not mods.has(m) then mods.add(m)
end
- dctx.sort(mods)
+
+ var intro = global.intro.mmmodule
+ var short_doc
+ dctx.add("<ul>\n")
for m in mods do
- if m == global.intro.mmmodule.toplevel_owner then
- dctx.add("<p>Introduced by {m.html_link(dctx)}")
- else
- dctx.add("<p>Refined by {m.html_link(dctx)}")
- end
- dctx.open_stage
- dctx.stage(". Definition in:")
- for lc in crhe.greaters do
+ short_doc = ""
+ if m.short_doc != " " then short_doc = ": {m.short_doc}"
+ dctx.add("<li>{m.html_link_to_anchor}{short_doc}")
+ dctx.add("<ul>\n")
+ for lc in crhe.linear_extension.reversed do
if lc.mmmodule.toplevel_owner != m then continue
- dctx.add(" {lc.mmmodule.html_link(dctx)}")
- assert lc isa MMSrcLocalClass
- var n = lc.node
- if n != null then
- dctx.show_source(n.location)
- end
+ if lc.mmmodule == m then continue
+ short_doc = ""
+ if lc.mmmodule.short_doc != " " then short_doc = ": {lc.mmmodule.short_doc}"
+ dctx.add("<li>{lc.mmmodule.html_link_to_anchor}{short_doc}</li>")
end
- dctx.close_stage
- dctx.add("</p>\n")
+ dctx.add("</ul>\n")
+ dctx.add("</li>\n")
end
dctx.add("</ul>\n")
-
- dctx.add("</section>\n")
+ dctx.stage("</section>\n")
+ dctx.close_stage
dctx.open_stage
dctx.stage("<section class=\"types\">\n")
dctx.open_stage
dctx.stage("<section class=\"methods\">\n")
dctx.stage("<h2 class=\"section-header\">Methods</h2>\n")
+ var redefs = new HashMap[MMModule, HashMap[MMModule, Array[MMMethod]]]
for p in props do
if p.global.is_init then continue
if p.local_class.global != self.global then continue
if not p isa MMMethod then continue
- p.full_documentation(dctx, self)
+ # Top level module
+ var toplevel_module = p.mmmodule.toplevel_owner
+ if not redefs.has_key(toplevel_module) then
+ redefs[toplevel_module] = new HashMap[MMModule, Array[MMMethod]]
+ end
+ # Nested module
+ var nested_module = p.mmmodule
+ if not redefs[toplevel_module].has_key(nested_module) then
+ redefs[toplevel_module][nested_module] = new Array[MMMethod]
+ end
+ # Props
+ redefs[toplevel_module][nested_module].add(p)
+
+ # Redefs
+ if p.mmmodule.toplevel_owner != p.intro_module then
+ toplevel_module = p.intro_module
+ nested_module = p.global.intro.mmmodule
+
+ if not redefs.has_key(toplevel_module) then
+ redefs[toplevel_module] = new HashMap[MMModule, Array[MMMethod]]
+ end
+ if not redefs[toplevel_module].has_key(nested_module) then
+ redefs[toplevel_module][nested_module] = new Array[MMMethod]
+ end
+
+ redefs[toplevel_module][nested_module].add(p.global.intro.as(MMMethod))
+ end
+ end
+
+ # Display toplevel blocks
+ for m in mods do
+ if not redefs.has_key(m) then continue
+ dctx.add(m.html_anchor)
+ if m != global.intro.mmmodule.toplevel_owner then
+ dctx.add("<h3 class=\"concern-toplevel\">Methods refined in {m.html_link(dctx)}</h3>")
+ end
+
+ # Display nested module blocks
+ for lc in crhe.linear_extension.reversed do
+ if lc.mmmodule.toplevel_owner != m then continue
+ var nm = lc.mmmodule
+ if not redefs[m].has_key(nm) then continue
+ dctx.add(nm.html_anchor)
+ if nm != global.intro.mmmodule then
+ short_doc = ""
+ if nm.short_doc != " " then short_doc = ": {nm.short_doc}"
+ dctx.add("<p class=\"concern-doc\">{nm.html_name}{short_doc}</p>\n")
+ end
+
+ var pps = redefs[m][nm]
+ dctx.sort(pps)
+ for p in pps do
+ p.full_documentation(dctx, self)
+ end
+ end
end
+
if not inhs.is_empty then
dctx.open_stage
- dctx.stage("<h3>Inherited Methods</h4>\n")
+ dctx.stage("<h3>Inherited Methods</h3>\n")
for lc in inhs do
dctx.open_stage
dctx.stage("<p>Defined in {lc.html_link(dctx)}:")
+
+ var ims = new Array[MMMethod]
for p in inh[lc] do
if p.global.is_init then continue
if not p isa MMMethod then continue
+ ims.add(p)
+ end
+
+ var i = 0
+ for p in ims do
dctx.add(" {p.html_link(dctx)}")
+ if i < ims.length - 1 then dctx.add(",")
+ i += 1
end
+
dctx.stage("</p>")
dctx.close_stage
end
var res = new Buffer
if arity > 0 then
res.append("(")
- res.append(self.params[0].name.to_s)
- res.append(": ")
- res.append(self[0].html_link(dctx))
- for i in [1..arity[ do
- res.append(", ")
+ for i in [0..arity[ do
+ if i > 0 then res.append(", ")
res.append(self.params[i].name.to_s)
res.append(": ")
res.append(self[i].html_link(dctx))
+ if self.vararg_rank == i then
+ res.append("...")
+ end
end
res.append(")")
end