class YARD::Server::Adapter

Public Class Methods

setup() click to toggle source

To provide the templates necessary for `yard-lucid` to integrate with YARD the adapter has to around-alias the setup method to place the `yard-lucid` server templates as the last template in the list.

When they are normally loaded with the plugin they cause an error with the `yardoc` command. They are also not used because the YARD server templates are placed after all plugin templates.

# File lib/yard/server/adapter.rb, line 14
def setup
  yard_setup
  YARD::Templates::Engine.template_paths +=
  [File.dirname(__FILE__) + '/../../templates',File.dirname(__FILE__) + '/../../docserver']
end
Also aliased as: yard_setup
shutdown() click to toggle source

Similar to the addition, it is good business to tear down the templates that were added by again around-aliasing the shutdown method.

# File lib/yard/server/adapter.rb, line 24
def shutdown
  yard_shutdown
  YARD::Templates::Engine.template_paths -=
  [File.dirname(__FILE__) + '/../../templates',File.dirname(__FILE__) + '/../../docserver']
end
Also aliased as: yard_shutdown
yard_setup()
Alias for: setup
yard_shutdown()
Alias for: shutdown