logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Locale::Po4a::RubyDoc -- Convert Ruby Document data from/to PO files

Authors

       Francesco Poli <invernomuto@paranoici.org>

Description

       The po4a (PO for anything) project goal is to ease translations (and more interestingly, the maintenance
       of translations) using gettext tools on areas where they were not expected like documentation.

       Locale::Po4a::RubyDoc is a module to help the translation of documentation in the Ruby Document (RD)
       format (a language used to document Ruby) into other [human] languages.

Name

       Locale::Po4a::RubyDoc -- Convert Ruby Document data from/to PO files

Options Accepted By This Module

       This module supports the following option:

       puredoc
           Handle files entirely made of Ruby Document formatted text (without any "=begin" line).

           By  default,  this module only handles Ruby Document formatted text between "=begin" and "=end" lines
           (hence ignoring, among other things, everything that precedes the first "=begin" line).

See Also

Locale::Po4a::TransTractor(3pm)

Status Of This Module

       This module has been successfully tested on simple Ruby Document files covering a good part of the format
       syntax.

       A known limitation is that it fails to properly recognize the stacked structure of input Ruby Document:
       this implies that when, for instance, an EnumListItem consists of more than one Block, only the first
       Block is actually recognized as EnumListItem, while the subsequent ones are considered just as
       TextBlocks...

See Also