Class GetText::POEntry::Formatter
In: lib/gettext/po_entry.rb
Parent: Object

Methods

escape   format   new  

Included Modules

POFormat

Constants

DEFAULT_MAX_LINE_WIDTH = 78

Public Class methods

@param [POEntry] entry The entry to be formatted. @param [Hash] options @option options [Bool] :include_translator_comment (true)

  Includes translator comments in formatted string if true.

@option options [Bool] :include_extracted_comment (true)

  Includes extracted comments in formatted string if true.

@option options [Bool] :include_reference_comment (true)

  Includes reference comments in formatted string if true.

@option options [Bool] :include_flag_comment (true)

  Includes flag comments in formatted string if true.

@option options [Bool] :include_previous_comment (true)

  Includes previous comments in formatted string if true.

@option options [Bool] :include_all_comments (true)

  Includes all comments in formatted string if true.
  Other specific `:include_XXX` options get preference over
  this option.
  You can remove all comments by specifying this option as
  false and omitting other `:include_XXX` options.

@option options [Integer] :max_line_width (78)

  Wraps long lines that is longer than the `:max_line_width`.
  Don't break long lines if `:max_line_width` is less than 0
  such as `-1`.

@option options [Encoding] :encoding (nil)

  Encodes to the specific encoding.

Public Instance methods

[Validate]