class CmdSummary

nitc :: CmdSummary

Retrieve the MDoc summary

List all MarkdownHeading found and their ids.

Introduced properties

private var _markdown_processor: MarkdownProcessor

nitc :: CmdSummary :: _markdown_processor

Markdown processor used to parse the headlines
private var _summary: nullable ArrayMap[String, HeadLine]

nitc :: CmdSummary :: _summary

Resulting summary
init defaultinit(model: Model, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String, fallback: nullable Bool, full_doc: nullable Bool, format: nullable String, mdoc: nullable MDoc, markdown_processor: MarkdownProcessor, summary: nullable ArrayMap[String, HeadLine])

nitc :: CmdSummary :: defaultinit

fun markdown_processor: MarkdownProcessor

nitc :: CmdSummary :: markdown_processor

Markdown processor used to parse the headlines
fun markdown_processor=(markdown_processor: MarkdownProcessor)

nitc :: CmdSummary :: markdown_processor=

Markdown processor used to parse the headlines
fun summary: nullable ArrayMap[String, HeadLine]

nitc :: CmdSummary :: summary

Resulting summary
fun summary=(summary: nullable ArrayMap[String, HeadLine])

nitc :: CmdSummary :: summary=

Resulting summary

Redefined properties

redef type SELF: CmdSummary

nitc $ CmdSummary :: SELF

Type of this instance, automatically specialized in every class
redef fun init_command: CmdMessage

nitc $ CmdSummary :: init_command

Initialize the command

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 _fallback: Bool

nitc :: CmdComment :: _fallback

Allow fallback
private var _filter: nullable ModelFilter

nitc :: DocCommand :: _filter

ModelFilter to apply if any
private var _format: String

nitc :: CmdComment :: _format

Format to render the comment
private var _full_doc: Bool

nitc :: CmdComment :: _full_doc

Retrieve the full documentation
private var _markdown_processor: MarkdownProcessor

nitc :: CmdSummary :: _markdown_processor

Markdown processor used to parse the headlines
private var _mdoc: nullable MDoc

nitc :: CmdComment :: _mdoc

MDoc to return
private var _mentity: nullable MEntity

nitc :: CmdEntity :: _mentity

MEntity this command is about
private var _mentity_name: nullable String

nitc :: CmdEntity :: _mentity_name

Name of the mentity this command is about
private var _model: Model

nitc :: DocCommand :: _model

Model to retrieve data for
private var _summary: nullable ArrayMap[String, HeadLine]

nitc :: CmdSummary :: _summary

Resulting summary
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 cmd_filter: ModelFilter

nitc :: DocCommand :: cmd_filter

Return a new filter for that command execution.
init defaultinit(model: Model, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String)

nitc :: CmdEntity :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter)

nitc :: DocCommand :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String, fallback: nullable Bool, full_doc: nullable Bool, format: nullable String, mdoc: nullable MDoc, markdown_processor: MarkdownProcessor, summary: nullable ArrayMap[String, HeadLine])

nitc :: CmdSummary :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String, fallback: nullable Bool, full_doc: nullable Bool, format: nullable String, mdoc: nullable MDoc)

nitc :: CmdComment :: defaultinit

abstract fun execute(no_color: nullable Bool)

nitc :: DocCommand :: execute

fun fallback: Bool

nitc :: CmdComment :: fallback

Allow fallback
fun fallback=(fallback: nullable Bool)

nitc :: CmdComment :: fallback=

Allow fallback
fun filter: nullable ModelFilter

nitc :: DocCommand :: filter

ModelFilter to apply if any
protected fun filter=(filter: nullable ModelFilter)

nitc :: DocCommand :: filter=

ModelFilter to apply if any
fun format: String

nitc :: CmdComment :: format

Format to render the comment
fun format=(format: nullable String)

nitc :: CmdComment :: format=

Format to render the comment
fun full_doc: Bool

nitc :: CmdComment :: full_doc

Retrieve the full documentation
fun full_doc=(full_doc: nullable Bool)

nitc :: CmdComment :: full_doc=

Retrieve the full documentation
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.
fun http_init(req: HttpRequest): CmdMessage

nitc :: DocCommand :: http_init

Init the command from an HTTPRequest
init init

core :: Object :: init

fun init_command: CmdMessage

nitc :: DocCommand :: init_command

Initialize the command
fun init_mentity: CmdMessage

nitc :: CmdEntity :: init_mentity

Initialize the command mentity.
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 markdown_processor: MarkdownProcessor

nitc :: CmdSummary :: markdown_processor

Markdown processor used to parse the headlines
fun markdown_processor=(markdown_processor: MarkdownProcessor)

nitc :: CmdSummary :: markdown_processor=

Markdown processor used to parse the headlines
fun mdoc: nullable MDoc

nitc :: CmdComment :: mdoc

MDoc to return
fun mdoc=(mdoc: nullable MDoc)

nitc :: CmdComment :: mdoc=

MDoc to return
fun mentity: nullable MEntity

nitc :: CmdEntity :: mentity

MEntity this command is about
fun mentity=(mentity: nullable MEntity)

nitc :: CmdEntity :: mentity=

MEntity this command is about
fun mentity_name: nullable String

nitc :: CmdEntity :: mentity_name

Name of the mentity this command is about
fun mentity_name=(mentity_name: nullable String)

nitc :: CmdEntity :: mentity_name=

Name of the mentity this command is about
fun model: Model

nitc :: DocCommand :: model

Model to retrieve data for
protected fun model=(model: Model)

nitc :: DocCommand :: model=

Model to retrieve data for
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
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 parser_init(arg: String, options: CmdOptions): CmdMessage

nitc :: DocCommand :: parser_init

Initialize the command from the CommandParser data
fun render_comment: nullable Writable

nitc :: CmdComment :: render_comment

Render mdoc depending on full_doc and format
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun summary: nullable ArrayMap[String, HeadLine]

nitc :: CmdSummary :: summary

Resulting summary
fun summary=(summary: nullable ArrayMap[String, HeadLine])

nitc :: CmdSummary :: summary=

Resulting summary
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_html: Writable

nitc :: DocCommand :: to_html

Render results as a HTML string
abstract fun to_json: nullable Serializable

nitc :: DocCommand :: to_json

Return a JSON Serializable representation of self results
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_md: Writable

nitc :: DocCommand :: to_md

Render results as a Markdown string
fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram nitc::CmdSummary CmdSummary nitc::CmdComment CmdComment nitc::CmdSummary->nitc::CmdComment nitc::CmdEntity CmdEntity nitc::CmdComment->nitc::CmdEntity ...nitc::CmdEntity ... ...nitc::CmdEntity->nitc::CmdEntity

Ancestors

class CmdEntity

nitc :: CmdEntity

A command about a MEntity
abstract class DocCommand

nitc :: DocCommand

Documentation command
interface Object

core :: Object

The root of the class hierarchy.

Parents

class CmdComment

nitc :: CmdComment

Retrieve the MDoc related to a MEntity

Class definitions

nitc $ CmdSummary 
# Retrieve the MDoc summary
#
# List all MarkdownHeading found and their ids.
class CmdSummary
	super CmdComment

	# Markdown processor used to parse the headlines
	var markdown_processor: MarkdownProcessor is writable

	# Resulting summary
	#
	# Associates each headline to its id.
	var summary: nullable ArrayMap[String, HeadLine] = null is optional, writable

	redef fun init_command do
		var res = super
		if not res isa CmdSuccess then return res
		var mentity = self.mentity.as(not null)

		var mdoc = self.mdoc
		if mdoc == null then
			mdoc = if fallback then mentity.mdoc_or_fallback else mentity.mdoc
			self.mdoc = mdoc
		end
		if mdoc == null then return new WarningNoMDoc(mentity)

		markdown_processor.process(mdoc.md_documentation.write_to_string)

		var summary = new ArrayMap[String, HeadLine]
		summary.add_all markdown_processor.decorator.headlines
		self.summary = summary
		return res
	end
end
src/doc/commands/commands_docdown.nit:21,1--54,3
Nit tools. Version .