Multilanguage Doclet

Combine multilingual comments in the same source

Files

Description

This is a Java™ Doclet which allows you to embed multilingual text in your JavaDoc™ comments. It also should generate cleaner HTML than the standard doclet, and allows post-processing.

Language-specific clauses appear like this:

{@lang en Submit a task for execution.}
{@lang eo Liveru taskon por plenumado.}

You can ensure that only one from a group is used as follows:

{@select {@lang eo Liveru taskon por plenumado.}
{@else Submit a task for execution.}}

This, of course, could result in a lot of documentation per code, and I've never actually tried it in practice on a real library, so it could turn out to be completely impractical. Nevertheless, I wanted to sure it was possible and available if I would ever need it, and I was planning to write a doclet with better HTML output anyway.

Other features:

• You can mark some public methods as undocumented with an @undocumented tag.

• Factory methods can be identified with @constructor, so they get listed with constructors.

• An explicit @summary tag can be used instead of the implicit rules about delimiting the first line of an element description.

• The document­ation title, package groupings and contrib­utor details can be specified in the overview. From there, they can also be subject to multi­lingual content sel­ection.

• Version-​control keywords can be extracted from their sur­rounding syntax.

• 

  The doclet gener­ates a site­map file compat­ible with Standard-Navigation, making navig­ation of the document­ation easier.

See the file README.txt for more details.

The doclet class is uk.​ac.​lancs.​comp.​i18n_doclet.​SSDoclet.

Example output:

• HTTP Tools
• Sets, Maps and Collections
• Basic HTTP Proxylet Suite

(I use these for testing, so occasionally they might get corrupted.)

Sun, Sun Microsystems, the Sun Logo, Java, Javadoc are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.