class YARD::I18n::Message

@since 0.8.1
{#id} and some properties {#locations} and {#comments}.
Message is a translation target message. It has message ID as

def ==(other)

Returns:
  • (Boolean) - checks whether this message is equal to another.

Parameters:
  • other (Message) -- the +Message+ to be compared. 
def ==(other)
  other.is_a?(self.class) &&
    @id == other.id &&
    @locations == other.locations &&
    @comments == other.comments
end

def add_comment(comment)

Returns:
  • (void) -

Parameters:
  • comment (String) -- the comment for the message to be added. 
def add_comment(comment)
  @comments << comment unless comment.nil?
end

def add_location(path, line)

Returns:
  • (void) -

Parameters:
  • line (Integer) -- the line number where the message appears.
  • path (String) -- the path where the message appears. 
def add_location(path, line)
  @locations << [path, line]
end

def initialize(id)

Parameters:
  • id (String) -- the message ID of the translate target message. 
def initialize(id)
  @id = id
  @locations = Set.new
  @comments = Set.new
end