Class: YARD::CodeObjects::AppendixObject

Inherits:

Base

• Object
• Base
• YARD::CodeObjects::AppendixObject

Defined in:

lib/yard-appendix/code_objects/appendix_object.rb

Overview

An object that is spawned by the @!appendix directive.

See Also:

• Tags::AppendixDirective

Instance Method Summary

• #path ⇒ Object
• #title ⇒ Object
• #to_s ⇒ Object
• #type ⇒ Object

Instance Method Details

#path ⇒ Object

# File 'lib/yard-appendix/code_objects/appendix_object.rb', line 34

def path; ".#{type}.#{namespace && namespace.path}.#{name}" end

#title ⇒ Object

# File 'lib/yard-appendix/code_objects/appendix_object.rb', line 33

def title; "Appendix: #{name}" end

#to_s ⇒ Object

# File 'lib/yard-appendix/code_objects/appendix_object.rb', line 35

def to_s; "#{name}-appendix" end

#type ⇒ Object

# File 'lib/yard-appendix/code_objects/appendix_object.rb', line 32

def type; :appendix end