Class: YARD::I18n::Message
- Inherits:
-
Object
- Object
- YARD::I18n::Message
- Defined in:
- lib/yard/i18n/message.rb
Overview
Message
is a translation target message. It has message ID as #id and some properties #locations and #comments.
Instance Attribute Summary collapse
-
#comments ⇒ Set
readonly
The set of comments for the messages.
-
#id ⇒ String
readonly
The message ID of the trnslation target message.
-
#locations ⇒ Set
readonly
path and line number where the message is appeared.
Instance Method Summary collapse
-
#==(other) ⇒ Boolean
Checks whether this message is equal to another.
-
#add_comment(comment) ⇒ void
Adds a comment for the message.
-
#add_location(path, line) ⇒ void
Adds location information for the message.
-
#initialize(id) ⇒ Message
constructor
Creates a trasnlate target message for message ID
id
.
Constructor Details
#initialize(id) ⇒ Message
Creates a trasnlate target message for message ID id
.
24 25 26 27 28 |
# File 'lib/yard/i18n/message.rb', line 24 def initialize(id) @id = id @locations = Set.new @comments = Set.new end |
Instance Attribute Details
#comments ⇒ Set (readonly)
Returns the set of comments for the messages.
19 20 21 |
# File 'lib/yard/i18n/message.rb', line 19 def comments @comments end |
#id ⇒ String (readonly)
Returns the message ID of the trnslation target message.
12 13 14 |
# File 'lib/yard/i18n/message.rb', line 12 def id @id end |
#locations ⇒ Set (readonly)
path and line number where the message is appeared.
16 17 18 |
# File 'lib/yard/i18n/message.rb', line 16 def locations @locations end |
Instance Method Details
#==(other) ⇒ Boolean
Returns checks whether this message is equal to another.
49 50 51 52 53 54 |
# File 'lib/yard/i18n/message.rb', line 49 def ==(other) other.is_a?(self.class) && @id == other.id && @locations == other.locations && @comments == other.comments end |
#add_comment(comment) ⇒ void
This method returns an undefined value.
Adds a comment for the message.
43 44 45 |
# File 'lib/yard/i18n/message.rb', line 43 def add_comment(comment) @comments << comment unless comment.nil? end |
#add_location(path, line) ⇒ void
This method returns an undefined value.
Adds location information for the message.
35 36 37 |
# File 'lib/yard/i18n/message.rb', line 35 def add_location(path, line) @locations << [path, line] end |