Module: CabbageDoc

Defined in:
lib/cabbage_doc.rb,
lib/cabbage_doc/web.rb,
lib/cabbage_doc/path.rb,
lib/cabbage_doc/task.rb,
lib/cabbage_doc/cache.rb,
lib/cabbage_doc/action.rb,
lib/cabbage_doc/client.rb,
lib/cabbage_doc/params.rb,
lib/cabbage_doc/parser.rb,
lib/cabbage_doc/worker.rb,
lib/cabbage_doc/example.rb,
lib/cabbage_doc/request.rb,
lib/cabbage_doc/version.rb,
lib/cabbage_doc/response.rb,
lib/cabbage_doc/cloneable.rb,
lib/cabbage_doc/parameter.rb,
lib/cabbage_doc/processor.rb,
lib/cabbage_doc/singleton.rb,
lib/cabbage_doc/collection.rb,
lib/cabbage_doc/controller.rb,
lib/cabbage_doc/customizer.rb,
lib/cabbage_doc/web_helper.rb,
lib/cabbage_doc/configuration.rb,
lib/cabbage_doc/authentication.rb,
lib/cabbage_doc/processors/documentation.rb

Defined Under Namespace

Modules: Cloneable, Helpers, Parser, Processors, Singleton, WebHelper, Worker Classes: Action, Authentication, Cache, Client, Collection, Configuration, Controller, Customizer, Example, Parameter, Params, Path, Processor, Request, Response, Task, Web

Constant Summary collapse

MARKER = 
':cabbagedoc:'.freeze
VISIBILITY = 
%i(public private internal beta).freeze
VISIBILITY_REGEXP = 
VISIBILITY.map(&:to_s).map(&:capitalize).join('|').freeze
VERSION = 
"0.0.7".freeze

Class Method Summary collapse

Class Method Details

.configure ⇒ Object 



30
31
32
33
34
35
 
# File 'lib/cabbage_doc.rb', line 30

def configure
  Configuration.instance.tap do |config|
    yield config if block_given?
    config.validate!
  end
end