class YARD::I18n::Message
Message
is a translation target message. It has message ID as {#id} and some properties {#locations} and {#comments}.
@since 0.8.1
Attributes
@return [Set] the set of comments for the messages.
@return [String] the message ID of the translation target message.
@return [Set] the set of locations. Location is an array of path and line number where the message is appeared.
Public Class Methods
Source
# File lib/yard/i18n/message.rb, line 24 def initialize(id) @id = id @locations = Set.new @comments = Set.new end
Creates a translate target message for message ID id
.
@param [String] id the message ID of the translate target message.
Public Instance Methods
Source
# 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
@param [Message] other the Message
to be compared. @return [Boolean] checks whether this message is equal to another.
Source
# File lib/yard/i18n/message.rb, line 43 def add_comment(comment) @comments << comment unless comment.nil? end
Adds a comment for the message.
@param [String] comment the comment for the message to be added. @return [void]
Source
# File lib/yard/i18n/message.rb, line 35 def add_location(path, line) @locations << [path, line] end
Adds location information for the message.
@param [String] path the path where the message appears. @param [Integer] line the line number where the message appears. @return [void]