Method: JsDuck::Tag::Private#to_html

Defined in:
lib/jsduck/tag/private.rb

#to_html(context) ⇒ Object

Add notice to private classes



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/jsduck/tag/private.rb', line 24

def to_html(context)
  return unless context[:tagname] == :class

  return [
    "<div class='rounded-box private-box'>",
    "<p><strong>NOTE:</strong> This is a private utility class for internal use ",
    "by the framework. Don't rely on its existence.</p>",
    "</div>",
  ]
end