DESCRIPTION

The GettextDoclet class in a com.sun.javadoc.Standard doclet based
doclet that provides support to produce translated versions of
Javadoc documentation using GNU Gettext tools (see
http://www.gnu.org/software/gettext/ for details).

The documentation is produced in ordinary way with the optional use of
translation files prepared with Gettext tools. Every time this doclet
is run the processed javadoc comments are split to paragraphs which
can be translated independently. The resulting set of comments are
written to a PO-template (*.pot) file. Using the Gettext tools the
particular translation PO file can be created based on the template.
Every time this doclet is run the attempt is made to read the
translation file and a search for a traslation is made for every
comment processed. That procedure results in full or partly translated
documentation depending on the contents of the translation file and
their correspondence with the contents of the template file (that is
refreshed every time the doclet is run).

To run the doclet use -doclet option of the javadoc program:

  javadoc -doclet org.altlinux.doclet.gettext.GettextDoclet

Additional arguments this doclet receives:

  -locale  	   target locale -- language code or language and
  		   contry codes separated with the underscore;

  -po		   full name of the translation (PO) file;

  -podir	   the directory where to search for the PO files;
  
  -domain	   the base name of the translation file, by default
  		   the name of the package documentation is prepared
  		   for is used;

(if the name of the translation file is not explicitly specified with
the use of -po argument, it is assumed to be <podir>/<locale>/<domain>.po)

  -pot		   full name of the output translation template file;

  -potdir	   the directory where to write the template file;

(if the name of the translation template file is not explicitly
specified with the use of -pot argument, it is assumed to be
<potdir>/<domain>.pot)

  -charset	   the charset of the translation file (optional,
  		   attempt is made to read the proper charset name
  		   from the PO file metadata).

PROJECT HOST

Project is hosted at the Git.Alt:
http://git.altlinux.org/people/manowar/packages/gettext-doclet.git

CONTACT INFORMATION

SMTP: Paul Wolneykien <wolneykien@altlinux.org>
URL: ALT Linux, Ltd <http://www.altlinux.ru/>,
     <http://www.altlinux.org/>.

To know more about GNU Gettext localization system see
http://www.gnu.org/software/gettext/.