Class: Anydoc::Note

Inherits:

Data

• Object
• Data
• Anydoc::Note

Defined in:

lib/anydoc/document.rb,
sig/anydoc.rbs

Overview

A footnote or endnote body, referenced from text by a :note_ref inline.

Instance Attribute Summary

• #blocks ⇒ Array<Block> readonly

  The note's own content.

• #id ⇒ String readonly

  The id the referencing inline carries.

• #kind ⇒ Symbol readonly

  :footnote | :endnote.

Instance Attribute Details

#blocks ⇒ Array<Block> (readonly)

Returns the note's own content.

Returns:

• (Array<Block>) —

  the note's own content.

# File 'lib/anydoc/document.rb', line 205

class Note < Data.define(:id, :kind, :blocks)
end

#id ⇒ String (readonly)

Returns the id the referencing inline carries.

Returns:

• (String) —

  the id the referencing inline carries.

# File 'lib/anydoc/document.rb', line 205

class Note < Data.define(:id, :kind, :blocks)
end

#kind ⇒ Symbol (readonly)

:footnote | :endnote

Returns:

• (Symbol)

# File 'lib/anydoc/document.rb', line 205

class Note < Data.define(:id, :kind, :blocks)
end