aspose file tools*
The moose likes Beginning Java and the fly likes Multilanguage Javadoc comments and output. One language at a time. Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "Multilanguage Javadoc comments and output. One language at a time." Watch "Multilanguage Javadoc comments and output. One language at a time." New topic
Author

Multilanguage Javadoc comments and output. One language at a time.

Edwin F. López A.
Greenhorn

Joined: May 06, 2008
Posts: 2
Hello all and good day!

My question is related to javadoc.

I have a project that requires multilanguage code comments (es + en), going through the javadoc documentation, I could not find a tag that could help us to define when a description is in any specific language.

The specific requirement is to generate one set of documentation for any of the languages in which the javadoc is written given a flag or option. So, for instance, if english javadoc is required, then instruct javadoc to generate all of the comments specified in english, ignoring the other languages.

Is this possible at all?
is there any resource I should go to understand better this application?
or I should just drop javadoc and go to another tool, let's say doxygen, to achieve this result?

I appreciate your comments and pointers on the issue.

Thank you very much.

________________________________
EdwinF.
Rob Spoor
Sheriff

Joined: Oct 27, 2005
Posts: 19670
    
  18

Javadoc doesn't support this out-of-the-box, but you could perhaps write your own Doclet class, then use this to generate the API documentation.

But perhaps in this case, doxygen is a bit easier. I can't tell you though since I haven't written a Doclet class nor used doxygen.


SCJP 1.4 - SCJP 6 - SCWCD 5 - OCEEJBD 6
How To Ask Questions How To Answer Questions
Edwin F. López A.
Greenhorn

Joined: May 06, 2008
Posts: 2
Rob Prime wrote:Javadoc doesn't support this out-of-the-box, but you could perhaps write your own Doclet class, then use this to generate the API documentation.
But perhaps in this case, doxygen is a bit easier. I can't tell you though since I haven't written a Doclet class nor used doxygen.


Thank you Rob. I appreciate it.
I'll check what would be easier/maintanable and update the post accordingly.

Have a very good day.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Multilanguage Javadoc comments and output. One language at a time.