nitc :: PageMClass
nitc :: PageMClass :: _api_tab
nitc :: PageMClass :: _dep_tab
nitc :: PageMClass :: defaultinit
nitc $ PageMClass :: SELF
Type of this instance, automatically specialized in every classnitc :: static_structure $ PageMClass :: apply_structure
Create the structure of this pagenitc :: static_structure $ PageMClass :: build_api
Build the API tabnitc :: static_structure $ PageMClass :: build_main
Build the main tab (the one that contains the MDoc)nitc :: PageMClass :: _api_tab
nitc :: PageMEntity :: _concerns
Concerns to display in this page.nitc :: PageMClass :: _dep_tab
nitc :: PageMEntity :: _html_url
template :: Template :: _is_frozen
Is the template allowing more modification (add)
template :: Template :: _is_writing
Flag to avoid infinite recursivity if a template contains itselfnitc :: PageMEntity :: _main_tab
For mentities the main tab is the doc tabnitc :: DocPage :: _piwik_script
Piwik script to append in the page scriptstemplate :: Template :: _render_done
Flag to avoid multiple renderingnitc :: PageMEntity :: _title
nitc :: DocPage :: apply_structure
Create the structure of this pagenitc :: PageMEntity :: build_dependencies
Build the dependencies tabnitc :: PageMEntity :: build_linearization
Build the linearization panelnitc :: PageMEntity :: build_main
Build the main tab (the one that contains the MDoc)core :: Object :: class_factory
Implementation used byget_class to create the specific class.
nitc :: PageMEntity :: concerns
Concerns to display in this page.nitc :: PageMEntity :: concerns=
Concerns to display in this page.core :: Object :: defaultinit
nitc :: PageMEntity :: defaultinit
template :: Template :: defaultinit
core :: Writable :: defaultinit
nitc :: DocPage :: defaultinit
nitc :: PageMClass :: defaultinit
template :: Template :: is_frozen=
Is the template allowing more modification (add)
core :: Object :: is_same_instance
Return true ifself and other are the same instance (i.e. same identity).
core :: Object :: is_same_serialized
Isself the same as other in a serialization context?
core :: Object :: is_same_type
Return true ifself and other have the same dynamic type.
template :: Template :: is_writing
Flag to avoid infinite recursivity if a template contains itselftemplate :: Template :: is_writing=
Flag to avoid infinite recursivity if a template contains itselfnitc :: PageMEntity :: mentity=
MEntity documented by this pagecore :: Object :: native_class_name
The class name of the object in CString format.nitc :: PageMEntity :: new
core :: Object :: output_class_name
Display class name on stdout (debug only).nitc :: DocPage :: piwik_script
Piwik script to append in the page scriptsnitc :: DocPage :: piwik_script=
Piwik script to append in the page scriptstemplate :: Template :: render_done=
Flag to avoid multiple renderingcore :: Writable :: write_to_bytes
Likewrite_to but return a new Bytes (may be quite large)
core :: Writable :: write_to_file
Likewrite_to but take care of creating the file
core :: Writable :: write_to_string
Likewrite_to but return a new String (may be quite large).
# A documentation page about a MClass
class PageMClass
super PageMEntity
redef type MENTITY: MClass
redef var api_tab = new DocTab("api", "All properties", false, "list")
redef var dep_tab = new DocTab("inh", "Inheritance", false, "object-align-vertical")
redef var tabs = [main_tab, api_tab, dep_tab, lin_tab] is lazy
end
src/doc/static/static_base.nit:202,1--210,3
redef class PageMClass
redef fun apply_structure(doc) do
super
build_code(doc)
build_linearization(doc)
end
redef fun build_main(doc) do
super
var summary = new CardSummary(no_title = true)
# Intros
var cmd: CmdEntities = new CmdIntros(doc.model, doc.mainmodule, doc.filter, mentity)
cmd.init_command
var intros = cmd.results
if intros != null and intros.not_empty then
var section = new CardSection(3, "Introduced properties")
main_tab.content.add section
summary.cards.add section
var cards = new CardList("intros", "Intros")
for intro in intros do
var card = new CardMEntity(intro)
summary.cards.add card
cards.cards.add card
end
main_tab.content.add cards
end
# Redefs
cmd = new CmdRedefs(doc.model, doc.mainmodule, doc.filter, mentity)
cmd.init_command
var redefs = cmd.results
if redefs != null and redefs.not_empty then
var section = new CardSection(3, "Redefined properties")
main_tab.content.add section
summary.cards.add section
var cards = new CardList("redefs", "Redefs")
for prop in redefs do
var card = new CardMEntity(prop)
summary.cards.add card
cards.cards.add card
end
main_tab.content.add cards
end
# Expand summary
main_tab.sidebar.cards.add summary
end
redef fun build_api(doc) do
var summary = new CardSummary
var section = new CardSection(2, "All properties")
api_tab.content.add section
summary.cards.add section
var dq = new CmdAllProps(doc.model, doc.mainmodule, doc.filter, mentity)
dq.init_command
var mentities = dq.results
if mentities == null then return
var list = new CardList("api", "API")
for m in mentities do
var card = new CardMEntity(m)
list.cards.add card
summary.cards.add card
end
api_tab.content.add list
if summary.cards.not_empty then
api_tab.sidebar.cards.add summary
end
end
end
src/doc/static/static_structure.nit:289,1--363,3