Module: SketchUpYARD

Defined in:
lib/yard-sketchup.rb,
lib/yard-sketchup/version.rb,
lib/yard-sketchup/yard/handlers/class_constants.rb,
lib/yard-sketchup/yard/handlers/global_constants.rb,
lib/yard-sketchup/yard/handlers/class_enum_constants.rb

Defined Under Namespace

Classes: ClassConstantHandler, ClassEnumConstantHandler, GlobalConstantHandler

Constant Summary collapse

VERSION = 
'1.0.2'.freeze

Class Method Summary collapse

Class Method Details

.init ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/yard-sketchup.rb', line 10

def self.init
  # https://github.com/burtlo/yard-cucumber/blob/master/lib/yard-cucumber.rb

  # This registered template works for yardoc

  # YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/templates'

  # The following static paths and templates are for yard server

  # YARD::Server.register_static_path File.dirname(__FILE__) + "/templates/default/fulldoc/html"


  YARD::Templates::Engine.register_template_path self.templates_path

  # https://www.rubydoc.info/gems/yard/file/docs/TagsArch.md#Adding_Custom_Tags

  # https://github.com/lsegal/yard/issues/1227

  # Custom visible tags:

  tags = [
    YARD::Tags::Library.define_tag('Known Bugs', :bug),
  ]
  YARD::Tags::Library.visible_tags |= tags
end

.templates_path ⇒ Object 



28
29
30
 
# File 'lib/yard-sketchup.rb', line 28

def self.templates_path
  File.join(__dir__, 'yard-sketchup', 'templates')
end