Support for the Ruby 2.4 series has ended. See here for reference.

In Files

  • rdoc/generator/pot/po_entry.rb

Parent

Methods

Class/Module Index [+]

Quicksearch

RDoc::Generator::POT::POEntry

A PO entry in PO

Attributes

extracted_comment[R]

The comment content extracted from source file

flags[R]

The flags of the PO entry

msgid[R]

The msgid content

msgstr[R]

The msgstr content

references[R]

The locations where the PO entry is extracted

translator_comment[R]

The comment content created by translator (PO editor)

Public Class Methods

new(msgid, options = {}) click to toggle source

Creates a PO entry for msgid. Other valus can be specified by options.

 
               # File rdoc/generator/pot/po_entry.rb, line 29
def initialize msgid, options = {}
  @msgid = msgid
  @msgstr = options[:msgstr] || ""
  @translator_comment = options[:translator_comment]
  @extracted_comment = options[:extracted_comment]
  @references = options[:references] || []
  @flags = options[:flags] || []
end
            

Public Instance Methods

merge(other_entry) click to toggle source

Merges the PO entry with other_entry.

 
               # File rdoc/generator/pot/po_entry.rb, line 56
def merge other_entry
  options = {
    :extracted_comment  => merge_string(@extracted_comment,
                                        other_entry.extracted_comment),
    :translator_comment => merge_string(@translator_comment,
                                        other_entry.translator_comment),
    :references         => merge_array(@references,
                                       other_entry.references),
    :flags              => merge_array(@flags,
                                       other_entry.flags),
  }
  self.class.new(@msgid, options)
end
            
to_s() click to toggle source

Returns the PO entry in PO format.

 
               # File rdoc/generator/pot/po_entry.rb, line 41
  def to_s
    entry = ''
    entry << format_translator_comment
    entry << format_extracted_comment
    entry << format_references
    entry << format_flags
    entry << <<-ENTRY
msgid #{format_message(@msgid)}
msgstr #{format_message(@msgstr)}
    ENTRY
  end