class CmdManSynopsis

nitc :: CmdManSynopsis

Introduced properties

private var _synopsis: nullable String

nitc :: CmdManSynopsis :: _synopsis

Synopsis string extracted from man
init defaultinit(model: Model, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String, synopsis: nullable String)

nitc :: CmdManSynopsis :: defaultinit

fun synopsis: nullable String

nitc :: CmdManSynopsis :: synopsis

Synopsis string extracted from man
protected fun synopsis=(synopsis: nullable String)

nitc :: CmdManSynopsis :: synopsis=

Synopsis string extracted from man

Redefined properties

redef type SELF: CmdManSynopsis

nitc $ CmdManSynopsis :: SELF

Type of this instance, automatically specialized in every class
redef fun execute(no_color: nullable Bool)

nitc :: term $ CmdManSynopsis :: execute

redef fun init_command: CmdMessage

nitc $ CmdManSynopsis :: init_command

Initialize the command
redef fun to_html: Writable

nitc :: html_commands $ CmdManSynopsis :: to_html

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

nitc :: json_commands $ CmdManSynopsis :: to_json

Return a JSON Serializable representation of self results
redef fun to_md: Writable

nitc :: md_commands $ CmdManSynopsis :: to_md

Render results as a Markdown string

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 _file: nullable String

nitc :: CmdManFile :: _file

Man file
private var _filter: nullable ModelFilter

nitc :: DocCommand :: _filter

ModelFilter to apply if any
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 _synopsis: nullable String

nitc :: CmdManSynopsis :: _synopsis

Synopsis string extracted from man
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 :: CmdManFile :: 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, synopsis: nullable String)

nitc :: CmdManSynopsis :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String)

nitc :: CmdEntity :: defaultinit

abstract fun execute(no_color: nullable Bool)

nitc :: DocCommand :: execute

fun file: nullable String

nitc :: CmdManFile :: file

Man file
protected fun file=(file: nullable String)

nitc :: CmdManFile :: file=

Man file
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 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 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 serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun synopsis: nullable String

nitc :: CmdManSynopsis :: synopsis

Synopsis string extracted from man
protected fun synopsis=(synopsis: nullable String)

nitc :: CmdManSynopsis :: synopsis=

Synopsis string extracted from man
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::CmdManSynopsis CmdManSynopsis nitc::CmdManFile CmdManFile nitc::CmdManSynopsis->nitc::CmdManFile nitc::CmdEntity CmdEntity nitc::CmdManFile->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 CmdManFile

nitc :: CmdManFile

Cmd that finds the man file related to an mentity

Class definitions

nitc $ CmdManSynopsis 
class CmdManSynopsis
	super CmdManFile

	# Synopsis string extracted from man
	var synopsis: nullable String

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

		var lines = file.to_path.read_lines
		var in_synopsis = false
		for line in lines do
			if in_synopsis and line.has_prefix(mentity.name) then
				synopsis = line
				break
			end
			if line != "# SYNOPSIS" then continue
			in_synopsis = true
		end

		if synopsis == null then return new WarningNoManSynopsis(mentity)

		return res
	end
end
src/doc/commands/commands_main.nit:249,1--276,3

nitc :: md_commands $ CmdManSynopsis 
redef class CmdManSynopsis
	redef fun to_md do
		var synopsis = self.synopsis
		if synopsis == null then return ""

		var tpl = new Template
		tpl.addn "~~~"
		tpl.addn synopsis
		tpl.addn "~~~"
		return tpl.write_to_string
	end
end
src/doc/templates/md_commands.nit:304,1--315,3

nitc :: json_commands $ CmdManSynopsis 
redef class CmdManSynopsis
	redef fun to_json do
		var obj = new JsonObject
		obj["synopsis"] = synopsis
		return obj
	end
end
src/doc/templates/json_commands.nit:280,1--286,3

nitc :: term $ CmdManSynopsis 
redef class CmdManSynopsis
	redef fun execute(no_color) do
		var mentity = self.mentity.as(not null).full_name
		if no_color == null or not no_color then mentity = mentity.blue.bold
		var title = "Synopsis for `{mentity}`:"

		if no_color == null or not no_color then
			print title.bold
		else
			print title
		end

		print ""
		var synopsis = self.synopsis
		if synopsis != null then print synopsis
	end
end
src/doc/term/term.nit:502,1--518,3

nitc :: html_commands $ CmdManSynopsis 
redef class CmdManSynopsis
	redef fun to_html do
		var synopsis = self.synopsis
		if synopsis == null then return ""

		return "<pre>{synopsis}</pre>"
	end
end
src/doc/templates/html_commands.nit:320,1--327,3
Nit tools. Version v0.8-3595-g3f58b4f.