lib/command_kit/examples.rb in command_kit-0.1.0.rc1 vs lib/command_kit/examples.rb in command_kit-0.1.0

- old
+ new

@@ -15,10 +15,13 @@ # module Examples include Help include CommandName + # + # @api private + # module ModuleMethods # # Extends {ClassMethods} or {ModuleMethods}, depending on whether # {Examples} is being included into a class or a module. # @@ -55,10 +58,12 @@ # @example # examples [ # "-o output.txt path/to/file" # ] # + # @api public + # def examples(new_examples=nil) if new_examples @examples = Array(new_examples) else @examples || if superclass.kind_of?(ClassMethods) @@ -69,17 +74,21 @@ end # # @see ClassMethods#examples # + # @api semipublic + # def examples self.class.examples end # # Prints the command class'es example commands. # + # @api semipublic + # def help_examples if (examples = self.examples) puts puts "Examples:" examples.each do |command| @@ -90,11 +99,13 @@ # # Calls the superclass'es `#help` method, if it's defined, then calls # {#help_examples}. # + # @api public + # def help - super if defined?(super) + super help_examples end end end