for mmodule in mmodules do
var nmodule = mbuilder.mmodule2nmodule[mmodule]
pager.add("# module {mmodule.namespace}\n".bold)
- pager.add("import {mmodule.in_importation.direct_greaters.join(", ")}")
- #TODO add kmown clients
+ if not mmodule.in_importation.direct_greaters.is_empty then
+ pager.add("import ".bold + "{mmodule.in_importation.direct_greaters.join(", ")}\n")
+ end
+ if not mmodule.in_importation.direct_smallers.is_empty then
+ pager.add("known clients: ".bold + "{mmodule.in_importation.direct_smallers.join(", ")}\n")
+ end
pager.add_rule
pager.addn(nmodule.comment.green)
pager.add_rule
for cat, list in cats do
if not list.is_empty then
- pager.add("# {cat}\n".bold)
+ pager.add("# {cat}".bold)
for mclass in list do
var nclass = mbuilder.mclassdef2nclassdef[mclass.intro].as(AStdClassdef)
+ pager.add("")
if not nclass.short_comment.is_empty then
pager.add("\t# {nclass.short_comment}")
end
pager.add("\t\t" + "refined in {mclassdef.namespace}".gray)
end
end
- pager.add("")
end
end
end
var nclass = mbuilder.mclassdef2nclassdef[mclass.intro].as(AStdClassdef)
pager.add("# {mclass.namespace}\n".bold)
- pager.add("{mclass.short_doc} ")
- #TODO add kmown subclasses
+ pager.add("{mclass.short_doc}")
pager.add_rule
pager.addn(nclass.comment.green)
pager.add_rule
if not mclass.parameter_types.is_empty then
- pager.add("# formal types\n".bold)
+ pager.add("# formal types".bold)
for ft, bound in mclass.parameter_types do
- pager.add("\t{ft.to_s.green}: {bound}")
pager.add("")
+ pager.add("\t{ft.to_s.green}: {bound}")
end
end
if not mclass.virtual_types.is_empty then
- pager.add("# virtual types\n".bold)
+ pager.add("# virtual types".bold)
for vt in mclass.virtual_types do
- vt_fulldoc(pager, vt)
pager.add("")
+ vt_fulldoc(pager, vt)
end
end
pager.add_rule
for cat, list in cats do
if not list.is_empty then
- pager.add("# {cat}\n".bold)
+ pager.add("\n# {cat}".bold)
for mprop in list do
- method_fulldoc(pager, mprop)
pager.add("")
+ method_fulldoc(pager, mprop)
end
end
end
pager.render
end
- private fun props_fulldoc(mprops: List[MProperty]) do
+ private fun props_fulldoc(raw_mprops: List[MProperty]) do
var pager = new Pager
- # TODO group by module
- for mprop in mprops do
- if mprop isa MMethod and mbuilder.mpropdef2npropdef.has_key(mprop.intro) then
- method_fulldoc(pager, mprop)
- pager.add_rule
- else if mprop isa MVirtualTypeProp then
- vt_fulldoc(pager, mprop)
- pager.add_rule
+ # group by module
+ var cats = new HashMap[MModule, List[MProperty]]
+ for mprop in raw_mprops do
+ var mmodule = mprop.intro_mclassdef.mmodule
+ if not cats.has_key(mmodule) then cats[mmodule] = new List[MProperty]
+ cats[mmodule].add(mprop)
+ end
+ # display
+ for mmodule, mprops in cats do
+ pager.add("# {mmodule.namespace}".bold)
+ for mprop in mprops do
+ if mprop isa MMethod and mbuilder.mpropdef2npropdef.has_key(mprop.intro) then
+ pager.add("")
+ method_fulldoc(pager, mprop)
+ else if mprop isa MVirtualTypeProp then
+ pager.add("")
+ vt_fulldoc(pager, mprop)
+ end
end
+ pager.add_rule
end
pager.render
end
- private fun method_fulldoc(pager: Pager, mmethod: MMethod) do
- if mbuilder.mpropdef2npropdef.has_key(mmethod.intro) then
- var nmethod = mbuilder.mpropdef2npropdef[mmethod.intro]
- if nmethod isa AMethPropdef then
- if not nmethod.short_comment.is_empty then
- pager.add("\t# {nmethod.short_comment}")
- end
- pager.add("\t{nmethod}")
- pager.add("\t\t" + "introduced in {mmethod.intro_mclassdef.namespace}".gray)
- for mpropdef in mmethod.mpropdefs do
- if mpropdef != mmethod.intro then
- pager.add("\t\t" + "refined in {mpropdef.mclassdef.namespace}".gray)
- end
+ private fun method_fulldoc(pager: Pager, mprop: MMethod) do
+ if mbuilder.mpropdef2npropdef.has_key(mprop.intro) then
+ var nprop = mbuilder.mpropdef2npropdef[mprop.intro]
+ if not nprop.short_comment.is_empty then
+ pager.add("\t# {nprop.short_comment}")
+ end
+ if nprop isa AAttrPropdef then
+ pager.add("\t{nprop.read_accessor}")
+ pager.add("\t{nprop.write_accessor}")
+ else if nprop isa AMethPropdef then
+ pager.add("\t{nprop}")
+ end
+ pager.add("\t\t" + "introduced in {mprop.intro_mclassdef.namespace}".gray)
+ for mpropdef in mprop.mpropdefs do
+ if mpropdef != mprop.intro then
+ pager.add("\t\t" + "refined in {mpropdef.mclassdef.namespace}".gray)
end
end
end
if visibility.to_s == "public" then ret = "{ret}{to_s.green}"
if visibility.to_s == "private" then ret = "{ret}{to_s.red}"
if visibility.to_s == "protected" then ret = "{ret}{to_s.yellow}"
- ret = "{ret} super {parents.join(", ")}"
+ if not parents.is_empty then
+ ret = "{ret} super {parents.join(", ")}"
+ end
return ret
end
end
end
+redef class APropdef
+ private fun short_comment: String is abstract
+end
+
+redef class AAttrPropdef
+ redef fun short_comment do
+ var ret = ""
+ if n_doc != null then
+ var txt = n_doc.n_comment.first.text
+ txt = txt.replace("# ", "")
+ txt = txt.replace("\n", "")
+ ret += txt
+ end
+ return ret
+ end
+
+ private fun read_accessor: String do
+ var ret = "fun "
+ var name = mreadpropdef.mproperty.name
+ if mpropdef.mproperty.visibility.to_s == "public" then ret = "{ret}{name.green}"
+ if mpropdef.mproperty.visibility.to_s == "private" then ret = "{ret}{name.red}"
+ if mpropdef.mproperty.visibility.to_s == "protected" then ret = "{ret}{name.yellow}"
+ ret = "{ret}: {n_type.to_s}"
+ if n_kwredef != null then ret = "redef {ret}"
+ return ret
+ end
+
+ private fun write_accessor: String do
+ var ret = "fun "
+ var name = "{mreadpropdef.mproperty.name}="
+ if n_readable != null and n_readable.n_visibility != null then
+ if n_readable.n_visibility isa APublicVisibility then ret = "{ret}{name.green}"
+ if n_readable.n_visibility isa APrivateVisibility then ret = "{ret}{name.red}"
+ if n_readable.n_visibility isa AProtectedVisibility then ret = "{ret}{name.yellow}"
+ else
+ ret = "{ret}{name.red}"
+ end
+ ret = "{ret}({mreadpropdef.mproperty.name}: {n_type.to_s})"
+ if n_kwredef != null then ret = "redef {ret}"
+ return ret
+ end
+end
+
redef class AMethPropdef
- private fun short_comment: String do
+ redef fun short_comment do
var ret = ""
if n_doc != null then
var txt = n_doc.n_comment.first.text
nitlanguage / nit.git / blobdiff