Module: Apress::Documentation

Extended by:
Forwardable
Defined in:
lib/apress/documentation.rb,
lib/apress/documentation/engine.rb,
lib/apress/documentation/version.rb,
lib/apress/documentation/dsl/modules.rb,
lib/apress/documentation/dsl/document.rb,
lib/apress/documentation/swagger/schema.rb,
lib/apress/documentation/storage/modules.rb,
lib/apress/documentation/storage/document.rb,
lib/apress/documentation/dsl/swagger_document.rb,
lib/apress/documentation/storage/base_storage.rb,
app/helpers/apress/documentation/documents_helper.rb,
lib/apress/documentation/extensions/rgl/adjacency.rb,
lib/apress/documentation/storage/dependency_graph.rb,
lib/apress/documentation/storage/swagger_document.rb,
lib/apress/documentation/dsl/compilers/base_compiler.rb,
app/services/apress/documentation/swagger_json_builder.rb,
app/controllers/apress/documentation/swagger_controller.rb,
lib/apress/documentation/dsl/compilers/mixins/publicity.rb,
lib/apress/documentation/dsl/compilers/swagger_compiler.rb,
app/presenters/apress/documentation/dependency_presenter.rb,
lib/apress/documentation/dsl/compilers/document_compiler.rb,
lib/apress/documentation/dsl/compilers/mixins/dependable.rb,
app/controllers/apress/documentation/documents_controller.rb,
app/controllers/apress/documentation/swagger_ui_controller.rb,
app/controllers/concerns/apress/documentation/preload_docs.rb,
lib/apress/documentation/dsl/utils/swagger_bind_point_extractor.rb

Defined Under Namespace

Modules: DocumentsHelper, Dsl, Extensions, PreloadDocs, Storage, Swagger Classes: DependencyPresenter, DocumentsController, Engine, SwaggerController, SwaggerJsonBuilder, SwaggerUiController

Constant Summary collapse

VERSION = 
"0.4.0".freeze

Class Method Summary collapse

Class Method Details

.add_load_path(path) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/apress/documentation.rb', line 24

def self.add_load_path(path)
  ActiveSupport.on_load(:documentation) do
    Dir[File.join(path, '/**/*.rb')].each { |file| require file }

    yield if block_given?
  end
end

.modules ⇒ Object 



20
21
22
 
# File 'lib/apress/documentation.rb', line 20

def self.modules
  Apress::Documentation::Storage::Modules.instance
end

.reset! ⇒ Object 



32
33
34
35
 
# File 'lib/apress/documentation.rb', line 32

def self.reset!
  Apress::Documentation::Storage::DependencyGraph.instance.reset!
  modules.reset!
end

.validate_dependencies! ⇒ Object 



37
38
39
 
# File 'lib/apress/documentation.rb', line 37

def self.validate_dependencies!
  Apress::Documentation::Storage::DependencyGraph.instance.validate!
end