Class: DocMyRoutes::Documentation

Inherits:
Object
  • Object
show all
Defined in:
lib/doc_my_routes/doc/documentation.rb

Overview

class which contains the main functions to generate documentation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(routes, config) ⇒ Documentation

Returns a new instance of Documentation.



15
16
17
18
 
# File 'lib/doc_my_routes/doc/documentation.rb', line 15

def initialize(routes, config)
  @routes = routes
  @config = config
end

Instance Attribute Details

#routes ⇒ Object (readonly)

Returns the value of attribute routes.



9
10
11
 
# File 'lib/doc_my_routes/doc/documentation.rb', line 9

def routes
  @routes
end

Class Method Details

.generate ⇒ Object 



11
12
13
 
# File 'lib/doc_my_routes/doc/documentation.rb', line 11

def self.generate
  Documentation.new(RouteCollection.routes, DocMyRoutes.config).generate
end

Instance Method Details

#generate ⇒ Object 



20
21
22
23
24
 
# File 'lib/doc_my_routes/doc/documentation.rb', line 20

def generate
  generate_content
  generate_output
  copy_css_files
end