Class: JsDuck::Inline::Example

Inherits:
Object
  • Object
show all
Defined in:
lib/jsduck/inline/example.rb

Overview

Implementation of @example tag.

Looks for @example tag at the beginning of code blocks. When found, adds an “inline-example” CSS class to the <pre> element.

Unlike other Inline

classes this doesn’t implement an

@example tag as could be expected. But it fits nicely along with other inline tags as it’s processed inside DocFormatter, so it mostly fits here along with the others.

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ Example

Constructor takes opts parameter for consistency with other JsDuck::Inline::* classes.



17
18
19
 
# File 'lib/jsduck/inline/example.rb', line 17

def initialize(opts={})
  @re = /<pre><code>\s*@example( +[^\n]*)?\s+/m
end

Instance Method Details

#replace(input) ⇒ Object

Takes StringScanner instance.

Looks for “<pre><code>@example” at the current scan pointer position, when found, moves scan pointer forward and performs the apporpriate replacement.



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/jsduck/inline/example.rb', line 26

def replace(input)
  if input.check(@re)
    # Match possible classnames following @example and add them
    # as CSS classes inside <pre> element.
    input.scan(@re) =~ @re
    css_classes = ($1 || "").strip

    return "<pre class='inline-example #{css_classes}'><code>"
  else
    false
  end
end