Class: Documentation::Section

Inherits:
Base
  • Object
show all
Defined in:
lib/pdoc/parser/documentation_nodes.rb

Instance Method Summary collapse

Methods inherited from Base

#alias_of, #deprecated?, #ebnf_expressions, #inspect, #klass, #parent_id, #related_to, #root, #section_name, #serialize, #signature, #src_code_line, #tags, #to_yaml

Methods included from Memoized

#avoid_infinite_method_added_loop, #memoize, #method_added

Instance Method Details

#description ⇒ Object

Returns section’s description



223
224
225
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 223

def description
  section.description
end

#doc_parent ⇒ Object

Returns nil.



258
259
260
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 258

def doc_parent
  nil
end

#full_name ⇒ Object

Returns section’s full_name



213
214
215
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 213

def full_name
  "#{section.name} section"
end

#global? ⇒ Boolean

Returns false.

Returns:

  • (Boolean) 


238
239
240
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 238

def global?
  false
end

#klass_name ⇒ Object

Returns nil.



233
234
235
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 233

def klass_name
  nil
end

#name ⇒ Object

Returns section’s name



208
209
210
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 208

def name
  section.name
end

#namespace ⇒ Object

Returns nil.



243
244
245
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 243

def namespace
  nil
end

#namespace_string ⇒ Object

Returns an empty string.



248
249
250
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 248

def namespace_string
  ""
end

#section ⇒ Object

Returns nil.



253
254
255
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 253

def section
  nil
end

#text ⇒ Object

Returns section’s text



228
229
230
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 228

def text
  section.text
end

#title ⇒ Object

Returns section’s title



218
219
220
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 218

def title
  section.title
end

#type ⇒ Object

Returns “section”.



263
264
265
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 263

def type
  "section"
end