nitc :: DocModel :: _custom_intro
Custom homepage intro textnitc :: DocModel :: _inline_processor
Specific Markdown processor to use within Nitdocnitc :: DocModel :: _mainmodule
Mainmodule to resolve linearizationnitc :: DocModel :: _md_processor
Specific Markdown processor to use within Nitdocnitc :: DocModel :: _modelbuilder
ModelBuilder used to retrieve AST nodesnitc :: DocModel :: _name_sorter
Used to sort sidebar elements by name.nitc :: DocModel :: _piwik_site_id
Optional tracker site idnitc :: DocModel :: create_index_file
Build the nitdoc quick search indexnitc :: DocModel :: custom_brand=
Custom menu brandnitc :: DocModel :: custom_intro=
Custom homepage intro textnitc :: DocModel :: custom_title=
Custom homepage titlenitc :: DocModel :: defaultinit
nitc :: DocModel :: inline_processor
Specific Markdown processor to use within Nitdocnitc :: DocModel :: inline_processor=
Specific Markdown processor to use within Nitdocnitc :: DocModel :: mainmodule=
Mainmodule to resolve linearizationnitc :: DocModel :: md_processor
Specific Markdown processor to use within Nitdocnitc :: DocModel :: md_processor=
Specific Markdown processor to use within Nitdocnitc :: DocModel :: modelbuilder
ModelBuilder used to retrieve AST nodesnitc :: DocModel :: modelbuilder=
ModelBuilder used to retrieve AST nodesnitc :: DocModel :: name_sorter
Used to sort sidebar elements by name.nitc :: DocModel :: name_sorter=
Used to sort sidebar elements by name.nitc :: DocModel :: piwik_site_id=
Optional tracker site idnitc :: DocModel :: tracker_url=
Optional tracker urlnitc :: DocModel :: _custom_intro
Custom homepage intro textnitc :: DocModel :: _inline_processor
Specific Markdown processor to use within Nitdocnitc :: DocModel :: _mainmodule
Mainmodule to resolve linearizationnitc :: DocModel :: _md_processor
Specific Markdown processor to use within Nitdocnitc :: DocModel :: _modelbuilder
ModelBuilder used to retrieve AST nodesnitc :: DocModel :: _name_sorter
Used to sort sidebar elements by name.nitc :: DocModel :: _piwik_site_id
Optional tracker site idcore :: Object :: class_factory
Implementation used byget_class
to create the specific class.
nitc :: DocModel :: create_index_file
Build the nitdoc quick search indexnitc :: DocModel :: custom_brand=
Custom menu brandnitc :: DocModel :: custom_intro=
Custom homepage intro textnitc :: DocModel :: custom_title=
Custom homepage titlecore :: Object :: defaultinit
nitc :: DocModel :: defaultinit
nitc :: DocModel :: inline_processor
Specific Markdown processor to use within Nitdocnitc :: DocModel :: inline_processor=
Specific Markdown processor to use within Nitdoccore :: 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.
nitc :: DocModel :: mainmodule=
Mainmodule to resolve linearizationnitc :: DocModel :: md_processor
Specific Markdown processor to use within Nitdocnitc :: DocModel :: md_processor=
Specific Markdown processor to use within Nitdocnitc :: DocModel :: modelbuilder
ModelBuilder used to retrieve AST nodesnitc :: DocModel :: modelbuilder=
ModelBuilder used to retrieve AST nodesnitc :: DocModel :: name_sorter
Used to sort sidebar elements by name.nitc :: DocModel :: name_sorter=
Used to sort sidebar elements by name.core :: Object :: native_class_name
The class name of the object in CString format.core :: Object :: output_class_name
Display class name on stdout (debug only).nitc :: DocModel :: piwik_site_id=
Optional tracker site idnitc :: DocModel :: tracker_url=
Optional tracker url
# The model of a Nitdoc documentation
class DocModel
# Model used to select entities
var model: Model
# Mainmodule to resolve linearization
var mainmodule: MModule
# ModelBuilder used to retrieve AST nodes
var modelbuilder: ModelBuilder
# Catalog for building the homepage
var catalog: Catalog
# Model filters applied to the whole documentation
var filter: ModelFilter
# Specific Markdown processor to use within Nitdoc
var md_processor: MarkdownProcessor is lazy do
var parser = new CommandParser(model, mainmodule, modelbuilder, catalog)
var proc = new CmdMarkdownProcessor(parser)
proc.decorator = new CmdDecorator(model)
return proc
end
# Specific Markdown processor to use within Nitdoc
var inline_processor: MarkdownProcessor is lazy do
var parser = new CommandParser(model, mainmodule, modelbuilder, catalog)
var proc = new CmdMarkdownProcessor(parser)
proc.decorator = new CmdInlineDecorator(model)
return proc
end
# Do not generate dot graphs
var no_dot = false is writable
# Do not generate higlighted code
var no_code = false is writable
# Url to code when `no_code` is true
var code_url: nullable String = null is writable
# Custom menu brand
var custom_brand: nullable String = null is writable
# Custom homepage title
var custom_title: nullable String = null is writable
# Custom homepage intro text
var custom_intro: nullable String = null is writable
# Optional tracker url
var tracker_url: nullable String = null is writable
# Optional tracker site id
var piwik_site_id: nullable String = null is writable
# Used to sort sidebar elements by name.
var name_sorter = new MEntityNameSorter
end
src/doc/static/static_base.nit:21,1--87,3
# Generate the index for then Nitdoc QuickSearch field.
#
# Create a JSON object containing links to:
# * mpackages
# * modules
# * mclasses
# * mpropdefs
# All entities are grouped by name to make the research easier.
#
# TODO Merge with model_index
redef class DocModel
# Build the nitdoc quick search index
fun create_index_file(file: String) do
var table = new QuickSearchTable(self)
var tpl = new Template
tpl.add "var nitdocQuickSearchRawList="
tpl.add table.to_json
tpl.add ";"
tpl.write_to_file(file)
end
end
src/doc/static/static_index.nit:21,1--42,3