Class: GLI::Commands::Doc::DocumentListener
- Inherits:
-
Object
- Object
- GLI::Commands::Doc::DocumentListener
- Defined in:
- lib/gli/commands/doc.rb
Overview
Interface for a listener that is called during various parts of the doc process
Instance Method Summary collapse
-
#beginning ⇒ Object
Called before processing begins.
-
#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
Called at the start of commands for the current context.
-
#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
Called when all commands for the current context have been vended.
-
#end_options ⇒ Object
Called when all options for the current context have been vended.
-
#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
Called at the start of options for the current context.
-
#program_desc(desc) ⇒ Object
Gives you the program description.
-
#program_long_desc(desc) ⇒ Object
Gives you the program long description.
-
#switch(name, aliases, desc, long_desc, negetable) ⇒ Object
Gives you a switch in the current context.
-
#version(version) ⇒ Object
Gives you the program version.
Instance Method Details
#beginning ⇒ Object
Called before processing begins
56 57 58 |
# File 'lib/gli/commands/doc.rb', line 56 def beginning abstract! end |
#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
116 117 118 |
# File 'lib/gli/commands/doc.rb', line 116 def command(name,aliases,desc,long_desc,arg_name,) abstract! end |
#commands ⇒ Object
Called at the start of commands for the current context
91 92 93 |
# File 'lib/gli/commands/doc.rb', line 91 def commands abstract! end |
#default_command(name) ⇒ Object
Gives you the name of the current command in the current context
111 112 113 |
# File 'lib/gli/commands/doc.rb', line 111 def default_command(name) abstract! end |
#end_command(name) ⇒ Object
Ends a command, and “pops” you back up one context
121 122 123 |
# File 'lib/gli/commands/doc.rb', line 121 def end_command(name) abstract! end |
#end_commands ⇒ Object
Called when all commands for the current context have been vended
96 97 98 |
# File 'lib/gli/commands/doc.rb', line 96 def end_commands abstract! end |
#end_options ⇒ Object
Called when all options for the current context have been vended
86 87 88 |
# File 'lib/gli/commands/doc.rb', line 86 def abstract! end |
#ending ⇒ Object
Called when processing has completed
61 62 63 |
# File 'lib/gli/commands/doc.rb', line 61 def ending abstract! end |
#flag(name, aliases, desc, long_desc, default_value, arg_name, must_match, type) ⇒ Object
Gives you a flag in the current context
101 102 103 |
# File 'lib/gli/commands/doc.rb', line 101 def flag(name,aliases,desc,long_desc,default_value,arg_name,must_match,type) abstract! end |
#options ⇒ Object
Called at the start of options for the current context
81 82 83 |
# File 'lib/gli/commands/doc.rb', line 81 def abstract! end |
#program_desc(desc) ⇒ Object
Gives you the program description
66 67 68 |
# File 'lib/gli/commands/doc.rb', line 66 def program_desc(desc) abstract! end |
#program_long_desc(desc) ⇒ Object
Gives you the program long description
71 72 73 |
# File 'lib/gli/commands/doc.rb', line 71 def program_long_desc(desc) abstract! end |
#switch(name, aliases, desc, long_desc, negetable) ⇒ Object
Gives you a switch in the current context
106 107 108 |
# File 'lib/gli/commands/doc.rb', line 106 def switch(name,aliases,desc,long_desc,negetable) abstract! end |
#version(version) ⇒ Object
Gives you the program version
76 77 78 |
# File 'lib/gli/commands/doc.rb', line 76 def version(version) abstract! end |