Class: JsDuck::Tag::Private

Inherits:
MetaTag
  • Object
show all
Defined in:
lib/jsduck/tag/private.rb

Overview

Implementation of @private tag.

Marks class/member as private.

Because :private is accessed a lot internally, it’s also injected to the main hash of documentation item.

Instance Attribute Summary

Attributes inherited from MetaTag

#assets, #boolean, #context, #formatter, #key, #multiline, #name, #position, #signature

Instance Method Summary collapse

Methods inherited from MetaTag

descendants, #format, #to_html, #to_value

Constructor Details

#initialize ⇒ Private

Returns a new instance of Private.



12
13
14
15
16
17
 
# File 'lib/jsduck/tag/private.rb', line 12

def initialize
  @name = "private"
  @key = :private
  @boolean = true
  @signature = {:long => "private", :short => "PRI"}
end