YARD plugin for Rubikon app documentation

[koraktor]

Apps using Rubikon should be easily documentable with YARD.

This would need a YARD plugin that does the following:

• detect Rubikon applications
• detect calls to DSL methods like command, flag etc.
• define new YARD tags like @arg to describe your code

So an example application may look like this:

class App < Rubikon::Application::Base

  # This is a flag and does nothing
  flag :f
  # This is an option and does even less
  # @arg [String] arg There is an argument to this option, but it is useless
  option :opt, 1
  # This command is competely useless, but it's fully documented
  # @arg [Number] This is the uselessness of this command
  command :cmd, 1 do
  end

end

[koraktor]

I'm working on this in yard-rubikon.