The model of a Nitdoc documentation

Introduced properties

private var _catalog: Catalog

nitc :: DocModel :: _catalog

Catalog for building the homepage
private var _code_url: nullable String

nitc :: DocModel :: _code_url

Url to code when no_code is true
private var _custom_brand: nullable String

nitc :: DocModel :: _custom_brand

Custom menu brand
private var _custom_intro: nullable String

nitc :: DocModel :: _custom_intro

Custom homepage intro text
private var _custom_title: nullable String

nitc :: DocModel :: _custom_title

Custom homepage title
private var _filter: ModelFilter

nitc :: DocModel :: _filter

Model filters applied to the whole documentation
private var _inline_processor: MarkdownProcessor

nitc :: DocModel :: _inline_processor

Specific Markdown processor to use within Nitdoc
private var _mainmodule: MModule

nitc :: DocModel :: _mainmodule

Mainmodule to resolve linearization
private var _md_processor: MarkdownProcessor

nitc :: DocModel :: _md_processor

Specific Markdown processor to use within Nitdoc
private var _model: Model

nitc :: DocModel :: _model

Model used to select entities
private var _modelbuilder: ModelBuilder

nitc :: DocModel :: _modelbuilder

ModelBuilder used to retrieve AST nodes
private var _name_sorter: MEntityNameSorter

nitc :: DocModel :: _name_sorter

Used to sort sidebar elements by name.
private var _no_code: Bool

nitc :: DocModel :: _no_code

Do not generate higlighted code
private var _no_dot: Bool

nitc :: DocModel :: _no_dot

Do not generate dot graphs
private var _piwik_site_id: nullable String

nitc :: DocModel :: _piwik_site_id

Optional tracker site id
private var _share_url: nullable String

nitc :: DocModel :: _share_url

Url to assets
private var _tracker_url: nullable String

nitc :: DocModel :: _tracker_url

Optional tracker url
fun catalog: Catalog

nitc :: DocModel :: catalog

Catalog for building the homepage
protected fun catalog=(catalog: Catalog)

nitc :: DocModel :: catalog=

Catalog for building the homepage
fun code_url: nullable String

nitc :: DocModel :: code_url

Url to code when no_code is true
fun code_url=(code_url: nullable String)

nitc :: DocModel :: code_url=

Url to code when no_code is true
fun create_index_file(file: String)

nitc :: DocModel :: create_index_file

Build the nitdoc quick search index
fun custom_brand: nullable String

nitc :: DocModel :: custom_brand

Custom menu brand
fun custom_brand=(custom_brand: nullable String)

nitc :: DocModel :: custom_brand=

Custom menu brand
fun custom_intro: nullable String

nitc :: DocModel :: custom_intro

Custom homepage intro text
fun custom_intro=(custom_intro: nullable String)

nitc :: DocModel :: custom_intro=

Custom homepage intro text
fun custom_title: nullable String

nitc :: DocModel :: custom_title

Custom homepage title
fun custom_title=(custom_title: nullable String)

nitc :: DocModel :: custom_title=

Custom homepage title
init defaultinit(model: Model, mainmodule: MModule, modelbuilder: ModelBuilder, catalog: Catalog, filter: ModelFilter)

nitc :: DocModel :: defaultinit

fun filter: ModelFilter

nitc :: DocModel :: filter

Model filters applied to the whole documentation
protected fun filter=(filter: ModelFilter)

nitc :: DocModel :: filter=

Model filters applied to the whole documentation
fun gen_page(page: DocPage, output_dir: String)

nitc :: DocModel :: gen_page

Generate a documentation page
fun inline_processor: MarkdownProcessor

nitc :: DocModel :: inline_processor

Specific Markdown processor to use within Nitdoc
protected fun inline_processor=(inline_processor: MarkdownProcessor)

nitc :: DocModel :: inline_processor=

Specific Markdown processor to use within Nitdoc
fun mainmodule: MModule

nitc :: DocModel :: mainmodule

Mainmodule to resolve linearization
protected fun mainmodule=(mainmodule: MModule)

nitc :: DocModel :: mainmodule=

Mainmodule to resolve linearization
fun md_processor: MarkdownProcessor

nitc :: DocModel :: md_processor

Specific Markdown processor to use within Nitdoc
protected fun md_processor=(md_processor: MarkdownProcessor)

nitc :: DocModel :: md_processor=

Specific Markdown processor to use within Nitdoc
fun model: Model

nitc :: DocModel :: model

Model used to select entities
protected fun model=(model: Model)

nitc :: DocModel :: model=

Model used to select entities
fun modelbuilder: ModelBuilder

nitc :: DocModel :: modelbuilder

ModelBuilder used to retrieve AST nodes
protected fun modelbuilder=(modelbuilder: ModelBuilder)

nitc :: DocModel :: modelbuilder=

ModelBuilder used to retrieve AST nodes
fun name_sorter: MEntityNameSorter

nitc :: DocModel :: name_sorter

Used to sort sidebar elements by name.
protected fun name_sorter=(name_sorter: MEntityNameSorter)

nitc :: DocModel :: name_sorter=

Used to sort sidebar elements by name.
fun no_code: Bool

nitc :: DocModel :: no_code

Do not generate higlighted code
fun no_code=(no_code: Bool)

nitc :: DocModel :: no_code=

Do not generate higlighted code
fun no_dot: Bool

nitc :: DocModel :: no_dot

Do not generate dot graphs
fun no_dot=(no_dot: Bool)

nitc :: DocModel :: no_dot=

Do not generate dot graphs
fun piwik_site_id: nullable String

nitc :: DocModel :: piwik_site_id

Optional tracker site id
fun piwik_site_id=(piwik_site_id: nullable String)

nitc :: DocModel :: piwik_site_id=

Optional tracker site id
fun share_url: nullable String

nitc :: DocModel :: share_url

Url to assets
fun share_url=(share_url: nullable String)

nitc :: DocModel :: share_url=

Url to assets
fun tracker_url: nullable String

nitc :: DocModel :: tracker_url

Optional tracker url
fun tracker_url=(tracker_url: nullable String)

nitc :: DocModel :: tracker_url=

Optional tracker url

Redefined properties

redef type SELF: DocModel

nitc $ DocModel :: SELF

Type of this instance, automatically specialized in every class

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
private var _catalog: Catalog

nitc :: DocModel :: _catalog

Catalog for building the homepage
private var _code_url: nullable String

nitc :: DocModel :: _code_url

Url to code when no_code is true
private var _custom_brand: nullable String

nitc :: DocModel :: _custom_brand

Custom menu brand
private var _custom_intro: nullable String

nitc :: DocModel :: _custom_intro

Custom homepage intro text
private var _custom_title: nullable String

nitc :: DocModel :: _custom_title

Custom homepage title
private var _filter: ModelFilter

nitc :: DocModel :: _filter

Model filters applied to the whole documentation
private var _inline_processor: MarkdownProcessor

nitc :: DocModel :: _inline_processor

Specific Markdown processor to use within Nitdoc
private var _mainmodule: MModule

nitc :: DocModel :: _mainmodule

Mainmodule to resolve linearization
private var _md_processor: MarkdownProcessor

nitc :: DocModel :: _md_processor

Specific Markdown processor to use within Nitdoc
private var _model: Model

nitc :: DocModel :: _model

Model used to select entities
private var _modelbuilder: ModelBuilder

nitc :: DocModel :: _modelbuilder

ModelBuilder used to retrieve AST nodes
private var _name_sorter: MEntityNameSorter

nitc :: DocModel :: _name_sorter

Used to sort sidebar elements by name.
private var _no_code: Bool

nitc :: DocModel :: _no_code

Do not generate higlighted code
private var _no_dot: Bool

nitc :: DocModel :: _no_dot

Do not generate dot graphs
private var _piwik_site_id: nullable String

nitc :: DocModel :: _piwik_site_id

Optional tracker site id
private var _share_url: nullable String

nitc :: DocModel :: _share_url

Url to assets
private var _tracker_url: nullable String

nitc :: DocModel :: _tracker_url

Optional tracker url
fun catalog: Catalog

nitc :: DocModel :: catalog

Catalog for building the homepage
protected fun catalog=(catalog: Catalog)

nitc :: DocModel :: catalog=

Catalog for building the homepage
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun code_url: nullable String

nitc :: DocModel :: code_url

Url to code when no_code is true
fun code_url=(code_url: nullable String)

nitc :: DocModel :: code_url=

Url to code when no_code is true
fun create_index_file(file: String)

nitc :: DocModel :: create_index_file

Build the nitdoc quick search index
fun custom_brand: nullable String

nitc :: DocModel :: custom_brand

Custom menu brand
fun custom_brand=(custom_brand: nullable String)

nitc :: DocModel :: custom_brand=

Custom menu brand
fun custom_intro: nullable String

nitc :: DocModel :: custom_intro

Custom homepage intro text
fun custom_intro=(custom_intro: nullable String)

nitc :: DocModel :: custom_intro=

Custom homepage intro text
fun custom_title: nullable String

nitc :: DocModel :: custom_title

Custom homepage title
fun custom_title=(custom_title: nullable String)

nitc :: DocModel :: custom_title=

Custom homepage title
init defaultinit(model: Model, mainmodule: MModule, modelbuilder: ModelBuilder, catalog: Catalog, filter: ModelFilter)

nitc :: DocModel :: defaultinit

fun filter: ModelFilter

nitc :: DocModel :: filter

Model filters applied to the whole documentation
protected fun filter=(filter: ModelFilter)

nitc :: DocModel :: filter=

Model filters applied to the whole documentation
fun gen_page(page: DocPage, output_dir: String)

nitc :: DocModel :: gen_page

Generate a documentation page
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inline_processor: MarkdownProcessor

nitc :: DocModel :: inline_processor

Specific Markdown processor to use within Nitdoc
protected fun inline_processor=(inline_processor: MarkdownProcessor)

nitc :: DocModel :: inline_processor=

Specific Markdown processor to use within Nitdoc
fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun mainmodule: MModule

nitc :: DocModel :: mainmodule

Mainmodule to resolve linearization
protected fun mainmodule=(mainmodule: MModule)

nitc :: DocModel :: mainmodule=

Mainmodule to resolve linearization
fun md_processor: MarkdownProcessor

nitc :: DocModel :: md_processor

Specific Markdown processor to use within Nitdoc
protected fun md_processor=(md_processor: MarkdownProcessor)

nitc :: DocModel :: md_processor=

Specific Markdown processor to use within Nitdoc
fun model: Model

nitc :: DocModel :: model

Model used to select entities
protected fun model=(model: Model)

nitc :: DocModel :: model=

Model used to select entities
fun modelbuilder: ModelBuilder

nitc :: DocModel :: modelbuilder

ModelBuilder used to retrieve AST nodes
protected fun modelbuilder=(modelbuilder: ModelBuilder)

nitc :: DocModel :: modelbuilder=

ModelBuilder used to retrieve AST nodes
fun name_sorter: MEntityNameSorter

nitc :: DocModel :: name_sorter

Used to sort sidebar elements by name.
protected fun name_sorter=(name_sorter: MEntityNameSorter)

nitc :: DocModel :: name_sorter=

Used to sort sidebar elements by name.
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
fun no_code: Bool

nitc :: DocModel :: no_code

Do not generate higlighted code
fun no_code=(no_code: Bool)

nitc :: DocModel :: no_code=

Do not generate higlighted code
fun no_dot: Bool

nitc :: DocModel :: no_dot

Do not generate dot graphs
fun no_dot=(no_dot: Bool)

nitc :: DocModel :: no_dot=

Do not generate dot graphs
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun piwik_site_id: nullable String

nitc :: DocModel :: piwik_site_id

Optional tracker site id
fun piwik_site_id=(piwik_site_id: nullable String)

nitc :: DocModel :: piwik_site_id=

Optional tracker site id
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun share_url: nullable String

nitc :: DocModel :: share_url

Url to assets
fun share_url=(share_url: nullable String)

nitc :: DocModel :: share_url=

Url to assets
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun tracker_url: nullable String

nitc :: DocModel :: tracker_url

Optional tracker url
fun tracker_url=(tracker_url: nullable String)

nitc :: DocModel :: tracker_url=

Optional tracker url
package_diagram nitc::DocModel DocModel core::Object Object nitc::DocModel->core::Object

Parents

interface Object

core :: Object

The root of the class hierarchy.

Class definitions

nitc $ DocModel
# 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

	# Url to assets
	var share_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 page footer
	var custom_footer: 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

nitc :: static_index $ DocModel
# 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

nitc :: nitdoc $ DocModel
redef class DocModel

	# Generate a documentation page
	fun gen_page(page: DocPage, output_dir: String) do
		page.apply_structure(self)
		page.render(self).write_to_file("{output_dir}/{page.html_url}")
	end
end
src/nitdoc.nit:93,1--100,3