Class: GLI::Commands::MarkdownDocumentListener

Inherits:

Object

• Object
• GLI::Commands::MarkdownDocumentListener

Defined in:

lib/doing/markdown_document_listener.rb

Overview

DocumentListener class for GLI documentation generator

Instance Method Summary

• #beginning ⇒ Object
• #command(name, aliases, desc, long_desc, arg_name, arg_options) ⇒ Object

  Gives you a command in the current context and creates a new context of this command.

• #commands ⇒ Object
• #default_command(name) ⇒ Object

  Gives you the name of the current command in the current context.

• #end_command(_name) ⇒ Object

  Ends a command, and "pops" you back up one context.

• #end_commands ⇒ Object
• #end_options ⇒ Object
• #ending ⇒ Object

  Called when processing has completed.

• #flag(name, aliases, desc, long_desc, default_value, arg_name, must_match, _type) ⇒ Object

  Gives you a flag in the current context.

• #initialize(_global_options, _options, _arguments, app) ⇒ MarkdownDocumentListener constructor

  A new instance of MarkdownDocumentListener.

• #options ⇒ Object
• #program_desc(desc) ⇒ Object

  Gives you the program description.

• #program_long_desc(desc) ⇒ Object
• #switch(name, aliases, desc, long_desc, negatable) ⇒ Object

  Gives you a switch in the current context.

• #version(version) ⇒ Object

  Gives you the program version.

Constructor Details

#initialize(_global_options, _options, _arguments, app) ⇒ MarkdownDocumentListener

Returns a new instance of MarkdownDocumentListener.

Instance Method Details

#beginning ⇒ Object

#command(name, aliases, desc, long_desc, arg_name, arg_options) ⇒ Object

Gives you a command in the current context and creates a new context of this command

#commands ⇒ Object

#default_command(name) ⇒ Object

Gives you the name of the current command in the current context

#end_command(_name) ⇒ Object

Ends a command, and "pops" you back up one context

#end_commands ⇒ Object

#end_options ⇒ Object

#ending ⇒ Object

Called when processing has completed

#flag(name, aliases, desc, long_desc, default_value, arg_name, must_match, _type) ⇒ Object

Gives you a flag in the current context

#options ⇒ Object

#program_desc(desc) ⇒ Object

Gives you the program description

#program_long_desc(desc) ⇒ Object

#switch(name, aliases, desc, long_desc, negatable) ⇒ Object

Gives you a switch in the current context

#version(version) ⇒ Object

Gives you the program version